dbServer Struct Reference

Server information structure. More...

#include <dbServer.h>

Collaboration diagram for dbServer:

Public Attributes
ELLNODE	node
	Linked list node; initialize to ELLNODE_INIT.
const char *	name
	A short server identifier; printable, with no spaces.
void(*	report )(unsigned level)
	Print level-dependent status report to stdout. More...
void(*	stats )(unsigned *channels, unsigned *clients)
	Get number of channels and clients currently connected. More...
int(*	client )(char *pBuf, size_t bufSize)
	Get identity of client initiating the calling thread. More...
Control Methods
These control methods for the server will be called by routines related to iocInit for all registered servers in turn when the IOC is being initialized, run, paused and stopped respectively.
void(*	init )(void)
	Server init method. More...
void(*	run )(void)
	Server run method. More...
void(*	pause )(void)
	Server pause method. More...
void(*	stop )(void)
	Server stop method. More...

Detailed Description

Every server layer should initialize and register an instance of this structure with the IOC by passing it to the dbRegisterServer() routine.

All methods in this struct are optional; use NULL if a server is unable to support a particular operation (or if it hasn't been implemented yet).

Definition at line 47 of file dbServer.h.

Member Data Documentation

void(* dbServer::report)(unsigned level)

Parameters

level

Interest level, specifies how much detail to print.

Definition at line 58 of file dbServer.h.

void(* dbServer::stats)(unsigned *channels, unsigned *clients)

Parameters

channels	NULL or pointer for returning channel count.
clients	NULL or pointer for returning client count.

Definition at line 65 of file dbServer.h.

int(* dbServer::client)(char *pBuf, size_t bufSize)

Must fill in the buffer with the client's identity when called from a thread that belongs to this server layer. For other threads, the method should do nothing, just return -1.

Parameters

pBuf	Buffer for client identity string.
bufSize	Number of chars available in pBuf.

Returns

-1 means calling thread is not owned by this server. 0 means the thread was recognized and pBuf has been filled in.

Definition at line 77 of file dbServer.h.

void(* dbServer::init)(void)

Called for all registered servers by dbInitServers().

Definition at line 91 of file dbServer.h.

void(* dbServer::run)(void)

Called for all registered servers by dbRunServers().

Definition at line 97 of file dbServer.h.

void(* dbServer::pause)(void)

Called for all registered servers by dbPauseServers().

Definition at line 103 of file dbServer.h.

void(* dbServer::stop)(void)

Called for all registered servers by dbStopServers().

Definition at line 109 of file dbServer.h.

---

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

• dbServer.h