com.onlineobject.objectnet Namespace

EmbeddedClient Members

The EmbeddedClient type exposes the following members.

Constructors


  Name Description
Public method EmbeddedClient(IEmbeddedClient, String)
Handles initial setup.
Public method EmbeddedClient(String)
Handles initial setup using the built-in UDP transport.

Methods


  Name Description
Public method ChangeTransport
Disconnects the client if it's connected and swaps out the transport it's using.
Public method Connect
Attempts to connect to a server at the given host address.
Public method Disconnect
Disconnects from the server.
Public method Send
Sends a message to the server.
Public method Update
Handles any received messages and invokes any delayed events which need to be invoked.

Properties


  Name Description
Public property Connection
The client's connection to a server.
Public property Id
The client's numeric ID.
Public property IsConnected
Whether or not the client is currently connected.
Public property IsConnecting
Whether or not the client is currently in the process of connecting.
Public property IsNotConnected
Whether or not the client is currently not trying to connect, pending, nor actively connected.
Public property IsPending
Whether or not the client's connection is currently pending (waiting to be accepted/rejected by the server).
Public property RTT
The round trip time (ping) of the connection, in milliseconds. -1 if not calculated yet.
Public property SmoothRTT
The smoothed round trip time (ping) of the connection, in milliseconds. -1 if not calculated yet.
Public property TimeoutTime
Sets the client's TimeoutTime.

Events


  Name Description
Public event ClientConnected
Invoked when another non-local client connects.
Public event ClientDisconnected
Invoked when another non-local client disconnects.
Public event Connected
Invoked when a connection to the server is established.
Public event ConnectionFailed
Invoked when a connection to the server fails to be established.
Public event Disconnected
Invoked when disconnected from the server.
Public event MessageReceived
Invoked when a message is received.