|
IServer Interface |
Defines a server involved in server-client communication.
Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.230-beta
Syntaxpublic interface IServer : ISupportLifecycle, IDisposable, IProvideStatus
The IServer type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ClientIDs | Gets the IDs of clients connected to the server. |
| ConfigurationString | Gets or sets the data required by the server to initialize. |
| CurrentState | Gets the current ServerState. |
| 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) |
| MaxClientConnections | Gets or sets the maximum number of clients that can 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 server for receiving data from the clients. |
| RunTime | Gets the Time for which the server has been running. |
| SendBufferSize | Gets or sets the size of the buffer used by the client for receiving data from the server. |
| ServerID | Gets the server's ID. |
| 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 connected clients. |
| TransportProtocol | Gets the TransportProtocol used by the server for the transportation of data with the clients. |
Methods| Name | Description | |
|---|---|---|
 | DisconnectAll | Disconnects all of the connected clients. |
| DisconnectOne | Disconnects a connected client. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Initialize |
Initializes the state of the object.
(Inherited from ISupportLifecycle) |
| Multicast | Sends data to all of the connected clients synchronously. |
| MulticastAsync | Sends data to all of the connected clients asynchronously. |
| Read | Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset. |
| SendTo | Sends data to the specified client synchronously. |
| SendToAsync | Sends data to the specified client asynchronously. |
| Start | Starts the server. |
| Stop | Stops the server. |
Events| Name | Description | |
|---|---|---|
 | ClientConnected | Occurs when a client connects to the server. |
| ClientConnectingException | Occurs when an exception is encountered while a client is connecting. |
| ClientDisconnected | Occurs when a client disconnects from the server. |
| Disposed |
Raised after the source object has been properly disposed.
(Inherited from ISupportLifecycle) |
| ReceiveClientData | Occurs when unprocessed data has been received from a client. |
| ReceiveClientDataComplete | Occurs when data received from a client has been processed and is ready for consumption. |
| ReceiveClientDataException | Occurs when an Exception is encountered when receiving data from a client. |
| SendClientDataComplete | Occurs when data has been sent to a client. |
| SendClientDataException | Occurs when an Exception is encountered when sending data to a client. |
| SendClientDataStart | Occurs when data is being sent to a client. |
| ServerStarted | Occurs when the server is started. |
| ServerStopped | Occurs when the server is stopped. |
| UnhandledUserException | Occurs when an Exception is encountered in a user-defined function via an event dispatch. |
See Also