EmbeddedClient Members
The EmbeddedClient type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
EmbeddedClient(IEmbeddedClient, String) |
Handles initial setup.
|
![]() |
EmbeddedClient(String) |
Handles initial setup using the built-in UDP transport.
|
Methods
Name | Description | |
---|---|---|
![]() |
ChangeTransport |
Disconnects the client if it's connected and swaps out the transport it's using.
|
![]() |
Connect |
Attempts to connect to a server at the given host address.
|
![]() |
Disconnect |
Disconnects from the server.
|
![]() |
Send |
Sends a message to the server.
|
![]() |
Update |
Handles any received messages and invokes any delayed events which need to be invoked.
|
Properties
Name | Description | |
---|---|---|
![]() |
Connection |
The client's connection to a server.
|
![]() |
Id |
The client's numeric ID.
|
![]() |
IsConnected |
Whether or not the client is currently connected.
|
![]() |
IsConnecting |
Whether or not the client is currently in the process of connecting.
|
![]() |
IsNotConnected |
Whether or not the client is currently not trying to connect, pending, nor actively connected.
|
![]() |
IsPending |
Whether or not the client's connection is currently pending (waiting to be accepted/rejected by the server).
|
![]() |
RTT |
The round trip time (ping) of the connection, in milliseconds. -1 if not calculated yet.
|
![]() |
SmoothRTT |
The smoothed round trip time (ping) of the connection, in milliseconds. -1 if not calculated yet.
|
![]() |
TimeoutTime |
Sets the client's TimeoutTime.
|
Events
Name | Description | |
---|---|---|
![]() |
ClientConnected |
Invoked when another non-local client connects.
|
![]() |
ClientDisconnected |
Invoked when another non-local client disconnects.
|
![]() |
Connected |
Invoked when a connection to the server is established.
|
![]() |
ConnectionFailed |
Invoked when a connection to the server fails to be established.
|
![]() |
Disconnected |
Invoked when disconnected from the server.
|
![]() |
MessageReceived |
Invoked when a message is received.
|