Server Monitor Interface. More...

Classes
struct	Server
	Server Entry. More...

struct	ServerSettings
	Server Reachability Settings. More...

struct	ServerStatus
	Server Reachability Status. More...

Public Types
enum	ServerReachability { WAITING, REACHABLE, UNREACHABLE, ERROR }
	Server Reachability State. More...

Public Member Functions
int	addServer (out int id, in ServerSettings settings)
	Add a new server entry. More...

int	modifyServer (in int id, in ServerSettings settings)
	Modify an existing server entry. More...

int	deleteServer (in int id)
	Delete a server entry. More...

int	getServer (out Server server, in int id)
	Retrieve a server entry (settings and status). More...

map< int, Server >	listServers ()
	Retrieve a list of server entries (settings and status). More...

Public Attributes
constant int	ERR_NO_SUCH_ID = 1
	No such ID.

constant int	ERR_INVALID_SETTINGS = 2
	Invalid settings.

constant int	ERR_DUPLICATE_HOSTNAME = 3
	Duplicate hostname.

constant int	ERR_MAX_SERVERS_REACHED = 4
	Maximum number of server entries.

Detailed Description

Server Monitor Interface.

Member Enumeration Documentation

Server Reachability State.

Enumerator
WAITING	Waiting for reliable connection.
REACHABLE	Server is up and running.
UNREACHABLE	No response from server.
ERROR	Error pinging server (e.g. DNS lookup failure)

int servermon::ServerMonitor_2_0_0::addServer	(	out int	id,
		in ServerSettings	settings
	)

Add a new server entry.

Parameters

id	New entry id, automatically assigned
settings	New server settings

Returns: 0 if OK; 2 if the settings are invalid; 3 if an entry for the given hostname exists; 4 if the maximum number of servers is reached

int servermon::ServerMonitor_2_0_0::deleteServer ( in int id )

Delete a server entry.

Parameters

id Entry id

int servermon::ServerMonitor_2_0_0::getServer	(	out Server	server,
		in int	id
	)

Retrieve a server entry (settings and status).

Parameters

server	Server settings and status
id	Entry id

map<int, Server> servermon::ServerMonitor_2_0_0::listServers ( )

Retrieve a list of server entries (settings and status).

int servermon::ServerMonitor_2_0_0::modifyServer	(	in int	id,
		in ServerSettings	settings
	)

Modify an existing server entry.

Parameters

id	Entry id
settings	New settings

Returns: 0 if OK; 1 if the entry does not exist; 2 if the settings are invalid; 3 if an entry for the given hostname exists

The documentation for this interface was generated from the following file: