IClient Interface

Defines a client involved in server-client communication.

Definition

Namespace: Gemstone.Communication
Assembly: Gemstone.Communication (in Gemstone.Communication.dll) Version: 1.0.150 -- Release Build+db91167944c21f6f51e864f1e794cb2c48194ae6
C#View SourceRequest Example
public interface IClient : ISupportLifecycle, 
	IDisposable, IProvideStatus
Implements
IProvideStatus, ISupportLifecycle, IDisposable

Properties

ConnectionString Gets or sets the data required by the client to connect to the server.
ConnectionTime Gets the Time for which the client has been connected to the server.
CurrentState Gets the current ClientState.
Enabled Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle)
IsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle)
MaxConnectionAttempts Gets or sets the maximum number of times the client will attempt to connect to the server.
Name Gets the name of the object providing status information.
(Inherited from IProvideStatus)
ReceiveBufferSize Gets or sets the size of the buffer used by the client for receiving data from the server.
SendBufferSize Gets or sets the size of the buffer used by the client for receiving data from the server.
ServerIndex Gets the current server index, when multiple server end points are defined.
ServerUri Gets the server URI.
Statistics Gets the TransportStatistics for the client connection.
Status Gets the current status details about object providing status information.
(Inherited from IProvideStatus)
TextEncoding Gets or sets the Encoding to be used for the text sent to the server.
TransportProtocol Gets the TransportProtocol used by the client for the transportation of data with the server.

Methods

Connect Connects client to the server synchronously.
ConnectAsync Connects client to the server asynchronously.
Disconnect Disconnects client from the server synchronously.
DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Initialize Initializes the state of the object.
(Inherited from ISupportLifecycle)
Read Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.
RequestNextServerIndex Requests that the client attempt to move to the next ServerIndex.
Send Sends data to the server synchronously.
SendAsync Sends data to the server asynchronously.

Events

ConnectionAttempt Occurs when client is attempting connection to the server.
ConnectionEstablished Occurs when client connection to the server is established.
ConnectionException Occurs when an Exception is encountered during connection attempt to the server.
ConnectionTerminated Occurs when client connection to the server is terminated.
Disposed Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle)
ReceiveData Occurs when unprocessed data has been received from the server.
ReceiveDataComplete Occurs when data received from the server has been processed and is ready for consumption.
ReceiveDataException Occurs when an Exception is encountered when receiving data from the server.
SendDataComplete Occurs when the client has successfully sent data to the server.
SendDataException Occurs when an Exception is encountered when sending data to the server.
SendDataStart Occurs when the client begins sending data to the server.

See Also