class Wacom::Kiosk::Integrator::MQServer
class Wacom::Kiosk::Integrator::MQServer
: public Wacom.Kiosk.Integrator.Server
A TCP server wrapper, utilizing byte array message communication between multiple tablet clients and the integrator server.
Summary
| Members | Descriptions |
|---|---|
{property} override ILogger Logger | Gets or sets a logger instance overriding the server Logger. |
{property} IEnumerable< ClientMetadata > clients | |
public inline MQServer(string certificate,string certificatePassword,int port,bool local) | The server constructor. |
public inline MQServer(X509Certificate2 certificate,int port,bool local) | The server constructor. |
public inline virtual override void UpdateClientContext(string clientName,int documentPage,string documentPath) | Updates client document context. |
public inline virtual override async void SendMessage(string clientAddress,byte[] msg) | Sends a byte message to the client specified. |
public inline virtual override void BroadcastMessage(byte[] msg) | Broadcasts a byte message to all connected clients, stored inside See also: ActiveClients . |
public inline virtual override void Dispose() | Closes all active client connections and disposes the TCP server instance. |
Members
{property} override ILogger Logger
Gets or sets a logger instance overriding the server Logger.
{property} IEnumerable< ClientMetadata > clients
public inline MQServer(string certificate,string certificatePassword,int port,bool local)
The server constructor.
Parameters
-
certificateThe server certificate name. -
certificatePasswordThe server ceritifcate password. -
portThe port for establishing client connections. Default is 5555. -
localA flag to set server listening mode. local = true will loopback connections. Default is false.
public inline MQServer(X509Certificate2 certificate,int port,bool local)
The server constructor.
Parameters
-
certificateThe server certificate. -
portThe port for establishing client connections. Default is 5555. -
localA flag to set server listening mode. local = true will loopback connections. Default is false.
public inline virtual override void UpdateClientContext(string clientName,int documentPage,string documentPath)
Updates client document context.
Parameters
-
clientNameThe name of the client. -
documentPageThe document page that the client is currently viewing. -
documentPathThe document path, placed on the integrator machine.
public inline virtual override async void SendMessage(string clientAddress,byte[] msg)
Sends a byte message to the client specified.
Parameters
-
clientAddressThe client name. -
msgThe message bytes to be sent.
public inline virtual override void BroadcastMessage(byte[] msg)
Broadcasts a byte message to all connected clients, stored inside See also: ActiveClients
.
Parameters
msgThe message bytes to be sent.
public inline virtual override void Dispose()
Closes all active client connections and disposes the TCP server instance.