Tes::Server::IConnectionMonitor Interface Reference

Inheritance diagram for Tes::Server::IConnectionMonitor:

List of all members.

Public Member Functions
bool	Start (ConnectionMonitorMode mode)
	Starts the monitor listening in the specified mode.
void	Stop ()
	Stops listening for further connections.
void	Join ()
	Called to join the monitor thread.
void	MonitorConnections ()
	Accepts new connections and checks for expired connections, but effects neither in the Server.
void	CommitConnections (NewConnectionCallback callback)
	Migrates new connections to the owning Server and removes expired connections.
Properties
ConnectionMonitorMode	Mode [get]
	Returns the current running mode.

---

Member Function Documentation

void Tes::Server::IConnectionMonitor::CommitConnections

(

NewConnectionCallback

callback

)

Migrates new connections to the owning Server and removes expired connections.

Parameters:

callback

Optional callback to invoke for each new connection.

Implemented in Tes::Server::ConnectionMonitor.

void Tes::Server::IConnectionMonitor::Join

(

)

Called to join the monitor thread.

Returns immediately if not running.

Implemented in Tes::Server::ConnectionMonitor.

void Tes::Server::IConnectionMonitor::MonitorConnections

(

)

Accepts new connections and checks for expired connections, but effects neither in the Server.

This is either called on the main thread for synchronous operation, or internally in asynchronous mode.

Implemented in Tes::Server::ConnectionMonitor.

bool Tes::Server::IConnectionMonitor::Start

(

ConnectionMonitorMode

mode

)

Starts the monitor listening in the specified mode.

Parameters:

mode	The listening mode. Mode Node is ignored.

Returns:

True if listening is running in the specified mode. This includes both newly started and if it was already running in that mode. False is returned if mode is

None

, or differs from the running mode.

The listening thread is started if mode is

Asynchronous

.

Implemented in Tes::Server::ConnectionMonitor.

void Tes::Server::IConnectionMonitor::Stop

(

)

Stops listening for further connections.

This requests termination of the monitor thread if running.

Safe to call if not running.

Implemented in Tes::Server::ConnectionMonitor.

---

Property Documentation

ConnectionMonitorMode Tes::Server::IConnectionMonitor::Mode [get]

Returns the current running mode.

Asyncrhonous

mode is set as soon as Start(ConnectionMonitorMode) is called and drops to

None

after calling Stop() once the thread has stopped.

Syncrhonous

mode is set as soon as Start(ConnectionMonitorMode) is called and drops to

None

on calling Stop().

The mode is

None

if not running in either mode.

Implemented in Tes::Server::ConnectionMonitor.

---

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

• IConnectionMonitor.cs