Gemstone Communication Library
Server
Base class for a server involved in server-client communication.
Definition
Namespace: Gemstone.Communication
Assembly: Gemstone.Communication (in Gemstone.Communication.dll) Version: 1.0.128 -- Release Build+c4e32e80ee4b39b519c6e4a0a25ff9269b8be666
Assembly: Gemstone.Communication (in Gemstone.Communication.dll) Version: 1.0.128 -- Release Build+c4e32e80ee4b39b519c6e4a0a25ff9269b8be666
C#
public abstract class ServerBase : IServer,
ISupportLifecycle, IDisposable, IProvideStatusVB
Public MustInherit Class ServerBase
Implements IServer, ISupportLifecycle, IDisposable, IProvideStatusC++
public ref class ServerBase abstract : IServer,
ISupportLifecycle, IDisposable, IProvideStatusJavaScript
Gemstone.Communication.ServerBase = function();
Type.createClass(
'Gemstone.Communication.ServerBase',
null,
Gemstone.Communication.IServer,
ISupportLifecycle,
IDisposable,
IProvideStatus);- Inheritance
- Object ServerBase
- Derived
- Implements
- IServer, IProvideStatus, ISupportLifecycle, IDisposable
Constructors
| ServerBase | Initializes a new instance of the server. |
| ServerBase(TransportProtocol, String) | Initializes a new instance of the server. |
Properties
| 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 server is currently enabled. |
| Initialized | Gets a boolean value that indicates whether the server has been initialized. |
| IsDisposed | Gets a flag that indicates whether the object has been disposed. |
| MaxClientConnections | Gets or sets the maximum number of clients that can connect to the server. |
| Name | Gets or sets the unique identifier of the server. |
| ReadIndicies | Gets current read indices for received data buffers incremented at each Read(Guid, Byte, Int32, Int32) call. |
| 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 server for sending data to the clients. |
| ServerID | Gets the server's ID. |
| Status | Gets the descriptive status of the server. |
| 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
| Create | Create a communications server |
| DisconnectAll | Disconnects all of the connected clients. |
| DisconnectOne | When overridden in a derived class, disconnects a connected client. |
| Dispose | Releases all the resources used by the ServerBase object. |
| Dispose(Boolean) | Releases the unmanaged resources used by the ServerBase object and optionally releases the managed resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | Initializes the server. |
| IsClientConnected | Determines whether the given client is currently connected to the server. |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Multicast(Byte) | Sends data to all of the connected clients synchronously. |
| Multicast(String) | Sends data to all of the connected clients synchronously. |
| Multicast(Byte, Int32, Int32) | Sends data to all of the connected clients synchronously. |
| MulticastAsync(Byte) | Sends data to all of the connected clients asynchronously. |
| MulticastAsync(String) | Sends data to all of the connected clients asynchronously. |
| MulticastAsync(Byte, Int32, Int32) | Sends data to all of the connected clients asynchronously. |
| OnClientConnected | Raises the ClientConnected event. |
| OnClientConnectingException | Raises the ClientConnectingException event. |
| OnClientDisconnected | Raises the ClientDisconnected event. |
| OnReceiveClientData | Raises the ReceiveClientData event. |
| OnReceiveClientDataComplete | Raises the ReceiveClientDataComplete event. |
| OnReceiveClientDataException | Raises the ReceiveClientDataException event. |
| OnSendClientDataComplete | Raises the SendClientDataComplete event. |
| OnSendClientDataException | Raises the SendClientDataException event. |
| OnSendClientDataStart | Raises the SendClientDataStart event. |
| OnServerStarted | Raises the ServerStarted event. |
| OnServerStopped | Raises the ServerStopped 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. |
| ReStart | Re-starts the server if currently running. |
| SendDataToAsync | When overridden in a derived class, sends data to the specified client asynchronously. |
| SendTo(Guid, Byte) | Sends data to the specified client synchronously. |
| SendTo(Guid, String) | Sends data to the specified client synchronously. |
| SendTo(Guid, Byte, Int32, Int32) | Sends data to the specified client synchronously. |
| SendToAsync(Guid, Byte) | Sends data to the specified client asynchronously. |
| SendToAsync(Guid, String) | Sends data to the specified client asynchronously. |
| SendToAsync(Guid, Byte, Int32, Int32) | Sends data to the specified client asynchronously. |
| Start | When overridden in a derived class, starts the server. |
| Stop | When overridden in a derived class, stops the server. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| ValidateConfigurationString | When overridden in a derived class, validates the specified configurationString. |
Events
| 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 | Occurs when the ServerBase has been disposed. |
| 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. |
Fields
| DefaultMaxClientConnections | Specifies the default value for the MaxClientConnections property. |
| DefaultReceiveBufferSize | Specifies the default value for the ReceiveBufferSize property. |
| DefaultSendBufferSize | Specifies the default value for the SendBufferSize property. |