ClientBase Class

Base class for a client involved in server-client communication.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      GSF.CommunicationClientBase
        More

Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

[ToolboxBitmapAttribute(typeof(ClientBase))]
public abstract class ClientBase : Component, 
	IClient, ISupportLifecycle, IDisposable, IProvideStatus, ISupportInitialize, 
	IPersistSettings

<ToolboxBitmapAttribute(GetType(ClientBase))>
Public MustInherit Class ClientBase
	Inherits Component
	Implements IClient, ISupportLifecycle, IDisposable, IProvideStatus, 
	ISupportInitialize, IPersistSettings

[ToolboxBitmapAttribute(typeof(ClientBase))]
public ref class ClientBase abstract : public Component, 
	IClient, ISupportLifecycle, IDisposable, IProvideStatus, ISupportInitialize, 
	IPersistSettings

[<AbstractClassAttribute>]
[<ToolboxBitmapAttribute(typeof(ClientBase))>]
type ClientBase = 
    class
        inherit Component
        interface IClient
        interface ISupportLifecycle
        interface IDisposable
        interface IProvideStatus
        interface ISupportInitialize
        interface IPersistSettings
    end

GSF.Communication.ClientBase = function();

Type.createClass(
	'GSF.Communication.ClientBase',
	Component,
	GSF.Communication.IClient,
	GSF.ISupportLifecycle,
	IDisposable,
	GSF.IProvideStatus,
	ISupportInitialize,
	GSF.Configuration.IPersistSettings);

View Source

The ClientBase type exposes the following members.

Constructors

	Name	Description
	ClientBase	Initializes a new instance of the client.
	ClientBase(TransportProtocol, String)	Initializes a new instance of the client.

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
	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.
	Container	Gets the IContainer that contains the Component. (Inherited from Component)
	CurrentState	Gets the current ClientState.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
	Enabled	Gets or sets a boolean value that indicates whether the client is currently enabled.
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
	IsDisposed	Gets a flag that indicates whether the object has been disposed.
	MaxConnectionAttempts	Gets or sets the maximum number of times the client will attempt to connect to the server.
	Name	Gets the unique identifier of the client.
	PersistSettings	Gets or sets a boolean value that indicates whether the client settings are to be saved to the config file.
	ReadIndex	Gets or sets current read index for received data buffer incremented at each Read(Byte, Int32, Int32) call.
	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 sending data to the server.
	ServerIndex	Gets the current server index, when multiple server end points are defined.
	ServerUri	Gets the server URI.
	SettingsCategory	Gets or sets the category under which the client settings are to be saved to the config file if the PersistSettings property is set to true.
	Site	Gets or sets the ISite of the Component. (Inherited from Component)
	Statistics	Gets the TransportStatistics for the client connection.
	Status	Gets the descriptive status of the client.
	TextEncoding	Gets or sets the Encoding to be used for the text sent to the server.
	TrackStatistics	Determines whether the base class should track statistics.
	TransportProtocol	Gets the TransportProtocol used by the client for the transportation of data with the server.

Top

Methods

	Name	Description
	BeginInit	Performs necessary operations before the client properties are initialized.
	Connect	Connects the client to the server synchronously.
	ConnectAsync	Connects the client to the server asynchronously.
	Create	Create a communications client
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject)
	Disconnect	When overridden in a derived class, disconnects client from the server synchronously.
	Dispose	Releases all resources used by the Component. (Inherited from Component)
	Dispose(Boolean)	Releases the unmanaged resources used by the client and optionally releases the managed resources. (Overrides ComponentDispose(Boolean))
	EndInit	Performs necessary operations after the client properties are initialized.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Initialize	Initializes the client.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
	LoadSettings	Loads saved client settings from the config file if the PersistSettings property is set to true.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
	OnConnectionAttempt	Raises the ConnectionAttempt event.
	OnConnectionEstablished	Raises the ConnectionEstablished event.
	OnConnectionException	Raises the ConnectionException event.
	OnConnectionTerminated	Raises the ConnectionTerminated event.
	OnReceiveData	Raises the ReceiveData event.
	OnReceiveDataComplete	Raises the ReceiveDataComplete event.
	OnReceiveDataException	Raises the ReceiveDataException event.
	OnSendDataComplete	Raises the SendDataComplete event.
	OnSendDataException	Raises the SendDataException event.
	OnSendDataStart	Raises the SendDataStart event.
	OnUnhandledUserException	Raises the UnhandledUserException event.
	Read	When overridden in a derived class, 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.
	SaveSettings	Saves client settings to the config file if the PersistSettings property is set to true.
	Send(Byte)	Sends data to the server synchronously.
	Send(Object)	Sends data to the server synchronously.
	Send(String)	Sends data to the server synchronously.
	Send(Byte, Int32, Int32)	Sends data to the server synchronously.
	SendAsync(Byte)	Sends data to the server asynchronously.
	SendAsync(Object)	Sends data to the server asynchronously.
	SendAsync(String)	Sends data to the server asynchronously.
	SendAsync(Byte, Int32, Int32)	Sends data to the server asynchronously.
	SendDataAsync	When overridden in a derived class, sends data to the server asynchronously.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)
	UpdateBytesReceived	Updates the Statistics pertaining to bytes received.
	UpdateBytesSent	Updates the Statistics pertaining to bytes sent.
	ValidateConnectionString	When overridden in a derived class, validates the specified connectionString.

Top

Events

	Name	Description
	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	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component)
	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.
	UnhandledUserException	Occurs when an Exception is encountered in a user-defined function via an event dispatch.

Top

Fields

	Name	Description
	DefaultMaxConnectionAttempts	Specifies the default value for the MaxConnectionAttempts property.
	DefaultPersistSettings	Specifies the default value for the PersistSettings property.
	DefaultReceiveBufferSize	Specifies the default value for the ReceiveBufferSize property.
	DefaultSendBufferSize	Specifies the default value for the SendBufferSize property.
	DefaultSettingsCategory	Specifies the default value for the SettingsCategory property.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.Communication Namespace

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      GSF.CommunicationClientBase
        GSF.CommunicationFileClient
        GSF.CommunicationSerialClient
        GSF.CommunicationTcpClient
        GSF.CommunicationTcpSimpleClient
        GSF.CommunicationTlsClient
        GSF.CommunicationUdpClient
        GSF.CommunicationZeroMQClient