Server
|
[ToolboxBitmapAttribute(typeof(ServerBase))] public abstract class ServerBase : Component, IServer, ISupportLifecycle, IDisposable, IProvideStatus, ISupportInitialize, IPersistSettings
The ServerBase type exposes the following members.
Name | Description | |
---|---|---|
ServerBase | Initializes a new instance of the server. | |
ServerBase(TransportProtocol, String) | Initializes a new instance of the server. |
Name | Description | |
---|---|---|
CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) | |
ClientIDs | Gets the IDs of clients connected to the server. | |
ConfigurationString | Gets or sets the data required by the server to initialize. | |
Container | Gets the IContainer that contains the Component. (Inherited from Component) | |
CurrentState | Gets the current ServerState. | |
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 server is currently enabled. | |
Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) | |
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 the unique identifier of the server. | |
PersistSettings | Gets or sets a boolean value that indicates whether the server settings are to be saved to the config file. | |
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. | |
SettingsCategory | Gets or sets the category under which the server 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) | |
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. |
Name | Description | |
---|---|---|
BeginInit | Performs necessary operations before the server properties are initialized. | |
Create | Create a communications server | |
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) | |
DisconnectAll | Disconnects all of the connected clients. | |
DisconnectOne | When overridden in a derived class, disconnects a connected client. | |
Dispose | Releases all resources used by the Component. (Inherited from Component) | |
Dispose(Boolean) |
Releases the unmanaged resources used by the server and optionally releases the managed resources.
(Overrides ComponentDispose(Boolean)) | |
EndInit | Performs necessary operations after the server 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 server. | |
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) | |
IsClientConnected | Determines whether the given client is currently connected to the server. | |
LoadSettings | Loads saved server 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) | |
Multicast(Byte) | Sends data to all of the connected clients synchronously. | |
Multicast(Object) | 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(Object) | 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. | |
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. | |
ReStart | Re-starts the server if currently running. | |
SaveSettings | Saves server settings to the config file if the PersistSettings property is set to true. | |
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, Object) | 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, Object) | 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 containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) | |
ValidateConfigurationString | When overridden in a derived class, validates the specified configurationString. |
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 | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) | |
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. |
Name | Description | |
---|---|---|
DefaultMaxClientConnections | Specifies the default value for the MaxClientConnections 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. |
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) |