Channel Methods
The Channel type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
ConfigureEncryption |
Configure how encryption wil works
Note: This methods allow to define any encryption alghorith
|
|
|
Connect()()()() |
Initiates a connection to the network server.
|
|
|
Connect(String, UInt16, UInt16, UInt16) |
Attempts to establish a connection using the provided IP address and ports.
|
|
|
Disconnect |
Disconnects the network server.
|
|
|
GetConnectedClient |
Gets the connected client with the specified connection ID.
|
|
|
GetConnectedClients |
Gets an array of connected clients.
|
|
|
GetConnectionID |
Retrieves the connection ID of the channel.
|
|
|
GetTransport |
Retrieves the current transport layer object.
|
|
|
IsConnected |
Checks if the network server is connected.
|
|
|
IsConnectionLost |
Checks if the network server has lost connection.
|
|
|
IsEncryptionEnabled |
Return if encryption is enabled
|
|
|
IsStarted |
Checks if the channel has been started.
|
|
|
IsTerminated |
Checks if the channel has been terminated.
|
|
|
OnClientConnected |
Registers a callback to be invoked when a client connects.
|
|
|
OnClientDisconnected |
Registers a callback to be invoked when a client disconnects.
|
|
|
OnConnected |
Registers a callback to be invoked when the connection is successfully established.
|
|
|
OnConnectionFailed |
Registers a callback to be invoked when the connection attempt fails.
|
|
|
OnDisconnected |
Registers a callback to be invoked when the connection is lost.
|
|
|
OnException |
Registers a callback to be invoked when an exception occurs.
|
|
|
OnMessageReceived |
Registers a callback to be invoked when a message is received.
|
|
|
Process |
Processes the network server by calling the Process method of the transport layer if it is not null.
|
|
|
RegisterClient |
Registers a client with the network server.
|
|
|
Send |
Sends data to the connected client or server.
|
|
|
SetConnectionID |
Sets the connection ID for the channel.
|
|
|
SetEncryptionEnabled |
Determine if encryption is enabled or not
|
|
|
SetIdleTimeout |
Sets the idle timeout for the network server.
|
|
|
SetIp |
Sets the IP address for the network server.
|
|
|
SetTcpPort |
Sets the TCP port for the network server.
|
|
|
SetTransport(String) |
Sets the transport layer by specifying the class name as a string.
|
|
|
SetTransport(ITransport) |
Sets the transport layer by providing an instance of an object that implements ITransport.
|
|
|
SetUdpPort |
Sets the UDP port for the network server.
|
|
|
Start |
Starts the channel and initializes the transport layer.
|
|
|
Stop |
Stops the network server, terminates the server and disconnects all clients.
|
|
|
Transmit |
Transmits data using the specified transport layer or the default one if none is specified.
|
|
|
UnregisterClient |
Unregisters a client from the network server.
|