3rd Eye Scene C#
3rd Eye Scene C# documentation
Tes::Server::ConnectionMonitor Class Reference

A TCP/IP based implementation of IConnectionMonitor. More...

Inheritance diagram for Tes::Server::ConnectionMonitor:
Tes::Server::IConnectionMonitor

List of all members.

Public Member Functions

 ConnectionMonitor (TcpServer server)
 Create a connection monitor for the given server.
bool Start (ConnectionMonitorMode mode)
 Start listening for connections in the given mode .
void Stop ()
 Stop listening for connections.
void Join ()
 Join the background thread if running ConnectionMonitorMode.Asynchronous.
void MonitorConnections ()
 Update the connection list.
void CommitConnections (NewConnectionCallback callback=null)
 Commit new and expired connections to the list and update the IServer.

Properties

ConnectionMonitorMode Mode [get, set]
 The connection mode.

Detailed Description

A TCP/IP based implementation of IConnectionMonitor.

To be used with TcpServer.

The IConnectionMonitor interface generally contains better documentation for the class members.


Constructor & Destructor Documentation

Tes::Server::ConnectionMonitor::ConnectionMonitor ( TcpServer  server) [inline]

Create a connection monitor for the given server.

Parameters:
serverThe server object.

Member Function Documentation

void Tes::Server::ConnectionMonitor::CommitConnections ( NewConnectionCallback  callback = null) [inline]

Commit new and expired connections to the list and update the IServer.

Parameters:
callbackThe callback to invoke for each new connection. May be null.

Must be called from the main thread, regardless of mode, to ensure the server reflects the current connection list.

Implements Tes::Server::IConnectionMonitor.

void Tes::Server::ConnectionMonitor::Join ( ) [inline]

Join the background thread if running ConnectionMonitorMode.Asynchronous.

Does nothing in other mods.

Implements Tes::Server::IConnectionMonitor.

void Tes::Server::ConnectionMonitor::MonitorConnections ( ) [inline]

Update the connection list.

Must be called from the main thread when running ConnectionMonitorMode.Synchronous.

Implements Tes::Server::IConnectionMonitor.

bool Tes::Server::ConnectionMonitor::Start ( ConnectionMonitorMode  mode) [inline]

Start listening for connections in the given mode .

Parameters:
mode
Returns:

Implements Tes::Server::IConnectionMonitor.


The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables Enumerations Properties Events