engine::ServerImpl Class Reference

Inheritance diagram for engine::ServerImpl:

Collaboration diagram for engine::ServerImpl:

Public Member Functions
	ServerImpl (const cloe::ServerConf &config)
bool	is_listening () const override
bool	is_streaming () const override
void	start () override
void	init_stream (const std::string &filename) override
void	stop () override
void	enroll (cloe::Registrar &r) override
std::unique_ptr< ServerRegistrar >	server_registrar () override
oak::Registrar	static_registrar ()
oak::ProxyRegistrar< cloe::HandlerType >	api_registrar ()
void	refresh_buffer_start_stream () override
void	refresh_buffer () override
Defer	lock () override
	ServerImpl (const cloe::ServerConf &config)
bool	is_listening () const override
bool	is_streaming () const override
void	start () override
void	init_stream (const std::string &) override
void	stop () override
void	enroll (cloe::Registrar &) override
std::unique_ptr< ServerRegistrar >	server_registrar () override
void	refresh_buffer_start_stream () override
void	refresh_buffer () override
Defer	lock () override
Public Member Functions inherited from engine::Server
	Server (const cloe::ServerConf &config)
const cloe::ServerConf &	config () const

Additional Inherited Members
Protected Member Functions inherited from engine::Server
cloe::Logger	logger () const
Protected Attributes inherited from engine::Server
cloe::ServerConf	config_

Member Function Documentation

enroll() [1/2]

void engine::ServerImpl::enroll ( cloe::Registrar &  r )

inlineoverridevirtual

Register a list of all endpoints.

Implements engine::Server.

enroll() [2/2]

void engine::ServerImpl::enroll ( cloe::Registrar &  r )

inlineoverridevirtual

Register a list of all endpoints.

Implements engine::Server.

Here is the call graph for this function:

init_stream() [1/2]

void engine::ServerImpl::init_stream ( const std::string &  filename )

inlineoverridevirtual

Open a file for api data streaming. This does not require a running web server.

Implements engine::Server.

init_stream() [2/2]

void engine::ServerImpl::init_stream ( const std::string &  filename )

inlineoverridevirtual

Open a file for api data streaming. This does not require a running web server.

Implements engine::Server.

is_listening() [1/2]

bool engine::ServerImpl::is_listening ( ) const

inlineoverridevirtual

Return whether the server is alive and listening for requests.

Implements engine::Server.

Here is the call graph for this function:

Here is the caller graph for this function:

is_listening() [2/2]

bool engine::ServerImpl::is_listening ( ) const

inlineoverridevirtual

Return whether the server is alive and listening for requests.

Implements engine::Server.

is_streaming() [1/2]

bool engine::ServerImpl::is_streaming ( ) const

inlineoverridevirtual

Return whether the server is currently streaming buffer data to a file.

If it is, expect performance to be bad.

Implements engine::Server.

Here is the caller graph for this function:

is_streaming() [2/2]

bool engine::ServerImpl::is_streaming ( ) const

inlineoverridevirtual

Return whether the server is currently streaming buffer data to a file.

If it is, expect performance to be bad.

Implements engine::Server.

lock() [1/2]

Defer engine::ServerImpl::lock ( )

inlineoverridevirtual

Return a write lock guard on the server.

Keep the returned value alive for as long as the server should be locked. Once the destructor is called, the lock is released.

Returns

Lock guard

Implements engine::Server.

Here is the call graph for this function:

lock() [2/2]

Defer engine::ServerImpl::lock ( )

inlineoverridevirtual

Return a write lock guard on the server.

Keep the returned value alive for as long as the server should be locked. Once the destructor is called, the lock is released.

Returns

Lock guard

Implements engine::Server.

refresh_buffer() [1/2]

void engine::ServerImpl::refresh_buffer ( )

inlineoverridevirtual

Refresh and/or write api data to a file.

Implements engine::Server.

Here is the call graph for this function:

refresh_buffer() [2/2]

void engine::ServerImpl::refresh_buffer ( )

inlineoverridevirtual

Refresh and/or write api data to a file.

Implements engine::Server.

refresh_buffer_start_stream() [1/2]

void engine::ServerImpl::refresh_buffer_start_stream ( )

inlineoverridevirtual

Refresh and/or start streaming api data to a file.

Implements engine::Server.

Here is the call graph for this function:

refresh_buffer_start_stream() [2/2]

void engine::ServerImpl::refresh_buffer_start_stream ( )

inlineoverridevirtual

Refresh and/or start streaming api data to a file.

Implements engine::Server.

server_registrar() [1/2]

std::unique_ptr<ServerRegistrar> engine::ServerImpl::server_registrar ( )

inlineoverridevirtual

Return a new ServerRegistrar that lets you register static content and API endpoints with the web server.

Implements engine::Server.

server_registrar() [2/2]

std::unique_ptr<ServerRegistrar> engine::ServerImpl::server_registrar ( )

inlineoverridevirtual

Return a new ServerRegistrar that lets you register static content and API endpoints with the web server.

Implements engine::Server.

start() [1/2]

void engine::ServerImpl::start ( )

inlineoverridevirtual

Start the web server.

Implements engine::Server.

Here is the call graph for this function:

start() [2/2]

void engine::ServerImpl::start ( )

inlineoverridevirtual

Start the web server.

Implements engine::Server.

stop() [1/2]

void engine::ServerImpl::stop ( )

inlineoverridevirtual

Stop all server-related procedures.

Implements engine::Server.

Here is the call graph for this function:

stop() [2/2]

void engine::ServerImpl::stop ( )

inlineoverridevirtual

Stop all server-related procedures.

Implements engine::Server.

---

The documentation for this class was generated from the following files:

• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/v0.23.0/engine/src/server.cpp
• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/v0.23.0/engine/src/server_mock.cpp