Click or drag to resize

IServer Interface

Defines a server involved in server-client communication.

Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.205-beta
Syntax
public interface IServer : ISupportLifecycle, 
	IDisposable, IProvideStatus

The IServer type exposes the following members.

Properties
 NameDescription
Public propertyClientIDs Gets the IDs of clients connected to the server.
Public propertyConfigurationString Gets or sets the data required by the server to initialize.
Public propertyCurrentState Gets the current ServerState.
Public propertyEnabled Gets or sets a boolean value that indicates whether the object is enabled.
(Inherited from ISupportLifecycle)
Public propertyIsDisposed Gets a flag that indicates whether the object has been disposed.
(Inherited from ISupportLifecycle)
Public propertyMaxClientConnections Gets or sets the maximum number of clients that can connect to the server.
Public propertyName Gets the name of the object providing status information.
(Inherited from IProvideStatus)
Public propertyReceiveBufferSize Gets or sets the size of the buffer used by the server for receiving data from the clients.
Public propertyRunTime Gets the Time for which the server has been running.
Public propertySendBufferSize Gets or sets the size of the buffer used by the client for receiving data from the server.
Public propertyServerID Gets the server's ID.
Public propertyStatus Gets the current status details about object providing status information.
(Inherited from IProvideStatus)
Public propertyTextEncoding Gets or sets the Encoding to be used for the text sent to the connected clients.
Public propertyTransportProtocol Gets the TransportProtocol used by the server for the transportation of data with the clients.
Top
Methods
 NameDescription
Public methodDisconnectAll Disconnects all of the connected clients.
Public methodDisconnectOne Disconnects a connected client.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodInitialize Initializes the state of the object.
(Inherited from ISupportLifecycle)
Public methodMulticast Sends data to all of the connected clients synchronously.
Public methodMulticastAsync Sends data to all of the connected clients asynchronously.
Public methodRead Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset.
Public methodSendTo Sends data to the specified client synchronously.
Public methodSendToAsync Sends data to the specified client asynchronously.
Public methodStart Starts the server.
Public methodStop Stops the server.
Top
Events
 NameDescription
Public eventClientConnected Occurs when a client connects to the server.
Public eventClientConnectingException Occurs when an exception is encountered while a client is connecting.
Public eventClientDisconnected Occurs when a client disconnects from the server.
Public eventDisposed Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle)
Public eventReceiveClientData Occurs when unprocessed data has been received from a client.
Public eventReceiveClientDataComplete Occurs when data received from a client has been processed and is ready for consumption.
Public eventReceiveClientDataException Occurs when an Exception is encountered when receiving data from a client.
Public eventSendClientDataComplete Occurs when data has been sent to a client.
Public eventSendClientDataException Occurs when an Exception is encountered when sending data to a client.
Public eventSendClientDataStart Occurs when data is being sent to a client.
Public eventServerStarted Occurs when the server is started.
Public eventServerStopped Occurs when the server is stopped.
Public eventUnhandledUserException Occurs when an Exception is encountered in a user-defined function via an event dispatch.
Top
See Also