ola::OlaServer Class Reference

Detailed Description

The main OlaServer class.

Inheritance diagram for ola::OlaServer:

Collaboration diagram for ola::OlaServer:

Classes
struct	ClientEntry
struct	Options
	Options for the OlaServer. More...

Public Member Functions
	OlaServer (const std::vector< class PluginLoader * > &plugin_loaders, class PreferencesFactory *preferences_factory, ola::io::SelectServer *ss, const Options &ola_options, ola::network::TCPAcceptingSocket *socket=NULL, ExportMap *export_map=NULL)
	Create a new instance of the OlaServer.
	~OlaServer ()
	Shutdown the server.
bool	Init ()
	Initialize the OlaServer.
void	ReloadPlugins ()
	Reload all plugins.
void	ReloadPidStore ()
	Reload the pid store.
void	StopServer ()
	Stop the OLA Server.
void	NewConnection (ola::io::ConnectedDescriptor *descriptor)
	Add a new ConnectedDescriptor to this Server.
ola::network::GenericSocketAddress	LocalRPCAddress () const
	Return the socket address the RPC server is listening on.
void	NewClient (ola::rpc::RpcSession *session)
	Called by the RpcServer when a client connects.
void	ClientRemoved (ola::rpc::RpcSession *session)
	Called by the RpcServer when a client disconnects.
const std::string	InstanceName ()
	Get the instance name.
const PreferencesFactory *	GetPreferencesFactory ()
	Get the preferences factory.

Static Public Attributes
static const unsigned int	DEFAULT_HTTP_PORT = 9090
static const unsigned int	DEFAULT_RPC_PORT = OLA_DEFAULT_PORT

Constructor & Destructor Documentation

ola::OlaServer::OlaServer	(	const std::vector< class PluginLoader * > &	plugin_loaders,
		class PreferencesFactory *	preferences_factory,
		ola::io::SelectServer *	ss,
		const Options &	ola_options,
		ola::network::TCPAcceptingSocket *	socket = NULL,
		ExportMap *	export_map = NULL
	)

Create a new instance of the OlaServer.

Parameters

plugin_loaders	A list of PluginLoaders to use to find plugins.
preferences_factory	The factory to use when creating Preference objects.
ss	The SelectServer.
ola_options	The OlaServer options.
socket	An optional TCPAcceptingSocket in the listen state to use for client RPC calls. Ownership is transferred.
export_map	An optional ExportMap. If set to NULL a new ExportMap will be created.

Member Function Documentation

void ola::OlaServer::ClientRemoved ( ola::rpc::RpcSession *  session )

virtual

Called by the RpcServer when a client disconnects.

Parameters

session

the RpcSession for the client.

Implements ola::rpc::RpcSessionHandlerInterface.

const PreferencesFactory* ola::OlaServer::GetPreferencesFactory ( )

inline

Get the preferences factory.

Returns

a pointer to the preferences factory

bool ola::OlaServer::Init

(

)

Initialize the OlaServer.

Returns

true if initialization succeeded, false if it failed.

const std::string ola::OlaServer::InstanceName ( )

inline

Get the instance name.

Returns

a string which is the instance name

ola::network::GenericSocketAddress ola::OlaServer::LocalRPCAddress

(

)

const

Return the socket address the RPC server is listening on.

Returns

A socket address, which is empty if the server hasn't been initialized.

void ola::OlaServer::NewClient ( ola::rpc::RpcSession *  session )

virtual

Called by the RpcServer when a client connects.

Parameters

session

the RpcSession for the client.

Implements ola::rpc::RpcSessionHandlerInterface.

void ola::OlaServer::NewConnection

(

ola::io::ConnectedDescriptor *

descriptor

)

Add a new ConnectedDescriptor to this Server.

Parameters

descriptor

the new ConnectedDescriptor, ownership is transferred.

void ola::OlaServer::ReloadPidStore

(

)

Reload the pid store.

This method is thread safe.

void ola::OlaServer::ReloadPlugins

(

)

Reload all plugins.

This method is thread safe.

void ola::OlaServer::StopServer ( )

inline

Stop the OLA Server.

This terminates the underlying SelectServer.

---

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

• olad/OlaServer.h
• olad/OlaServer.cpp