TlsServer Class

Represents a TCP-based communication server with SSL authentication and encryption.

Definition

Namespace: Gemstone.Communication
Assembly: Gemstone.Communication (in Gemstone.Communication.dll) Version: 1.0.147 -- Release Build+c4816753a7b0123e84413f8c19e7abd18c8e4cd0

C#View Source Request Example

public class TlsServer : ServerBase

VBView Source Request Example

Public Class TlsServer
	Inherits ServerBase

C++View Source Request Example

public ref class TlsServer : public ServerBase

JavaScriptView Source Request Example

Gemstone.Communication.TlsServer = function();

Type.createClass(
	'Gemstone.Communication.TlsServer',
	Gemstone.Communication.ServerBase);

Inheritance: Object ServerBase TlsServer

Constructors

TlsServer	Initializes a new instance of the TcpServer class.
TlsServer(String)	Initializes a new instance of the TcpServer class.

Properties

AllowDualStackSocket	Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6.
Certificate	Gets or sets the certificate used to identify this server.
CertificateChecker	Gets or sets the certificate checker used to validate remote certificates.
CertificateFile	Gets or sets the path to the certificate used for authentication.
CheckCertificateRevocation	Gets or sets a boolean value that determines whether the certificate revocation list is checked during authentication.
ClientIDs	Gets the IDs of clients connected to the server. (Inherited from ServerBase)
ConfigurationString	Gets or sets the data required by the server to initialize. (Inherited from ServerBase)
CurrentState	Gets the current ServerState. (Inherited from ServerBase)
Enabled	Gets or sets a boolean value that indicates whether the server is currently enabled. (Inherited from ServerBase)
EnabledSslProtocols	Gets or sets a set of flags which determine the enabled SslProtocols.
IgnoreInvalidCredentials	Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid.
Initialized	Gets a boolean value that indicates whether the server has been initialized. (Inherited from ServerBase)
IntegratedSecurity	Gets or sets a boolean value that indicates whether the client Windows account credentials are used for authentication.
IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from ServerBase)
LocalCertificateSelectionCallback	Gets or sets the callback used to select local certificates.
MaxClientConnections	Gets or sets the maximum number of clients that can connect to the server. (Inherited from ServerBase)
MaxSendQueueSize	Gets or sets the maximum size for the send queue before payloads are dumped from the queue.
Name	Gets or sets the unique identifier of the server. (Inherited from ServerBase)
NoDelay	Gets or sets a boolean value that determines if small packets are delivered to the remote host without delay.
PayloadAware	Gets or sets a boolean value that indicates whether the payload boundaries are to be preserved during transmission.
PayloadEndianOrder	Gets or sets the endian order to apply for encoding and decoding payload size in a PayloadAware transmission.
PayloadMarker	Gets or sets the byte sequence used to mark the beginning of a payload in a PayloadAware transmission.
ReadIndicies	Gets current read indices for received data buffers incremented at each Read(Guid, Byte, Int32, Int32) call. (Inherited from ServerBase)
ReceiveBufferSize	Gets or sets the size of the buffer used by the server for receiving data from the clients. (Inherited from ServerBase)
RemoteCertificateValidationCallback	Gets or sets the callback used to validate remote certificates.
RequireClientCertificate	Gets or sets a flag that determines whether a client certificate is required during authentication.
RunTime	Gets the Time for which the server has been running. (Inherited from ServerBase)
SendBufferSize	Gets or sets the size of the buffer used by the server for sending data to the clients. (Inherited from ServerBase)
Server	Gets the Socket object for the TcpServer.
ServerID	Gets the server's ID. (Inherited from ServerBase)
Status	Gets the descriptive status of the server. (Overrides ServerBaseStatus)
TextEncoding	Gets or sets the Encoding to be used for the text sent to the connected clients. (Inherited from ServerBase)
TransportProtocol	Gets the TransportProtocol used by the server for the transportation of data with the clients. (Inherited from ServerBase)
TrustedCertificatesPath	Gets or sets the path to the directory containing the trusted certificates.
ValidChainFlags	Gets or sets the set of valid chain flags used when validating remote certificates.
ValidPolicyErrors	Gets or sets the set of valid policy errors when validating remote certificates.

Methods

DisconnectAll	Disconnects all of the connected clients. (Inherited from ServerBase)
DisconnectOne	Disconnects the specified connected client. (Overrides ServerBaseDisconnectOne(Guid))
Dispose	Releases all the resources used by the ServerBase object. (Inherited from ServerBase)
Dispose(Boolean)	Releases the unmanaged resources used by the ServerBase object and optionally releases the managed resources. (Inherited from ServerBase)
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. (Inherited from ServerBase)
IsClientConnected	Determines whether the given client is currently connected to the server. (Inherited from ServerBase)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
Multicast(Byte)	Sends data to all of the connected clients synchronously. (Inherited from ServerBase)
Multicast(String)	Sends data to all of the connected clients synchronously. (Inherited from ServerBase)
Multicast(Byte, Int32, Int32)	Sends data to all of the connected clients synchronously. (Inherited from ServerBase)
MulticastAsync(Byte)	Sends data to all of the connected clients asynchronously. (Inherited from ServerBase)
MulticastAsync(String)	Sends data to all of the connected clients asynchronously. (Inherited from ServerBase)
MulticastAsync(Byte, Int32, Int32)	Sends data to all of the connected clients asynchronously. (Inherited from ServerBase)
OnClientConnected	Raises the ClientConnected event. (Inherited from ServerBase)
OnClientConnectingException	Raises the ClientConnectingException event. (Inherited from ServerBase)
OnClientDisconnected	Raises the ClientDisconnected event. (Inherited from ServerBase)
OnReceiveClientData	Raises the ReceiveClientData event. (Inherited from ServerBase)
OnReceiveClientDataComplete	Raises the ReceiveClientDataComplete event. (Inherited from ServerBase)
OnReceiveClientDataException	Raises the ReceiveClientDataException event. (Inherited from ServerBase)
OnSendClientDataComplete	Raises the SendClientDataComplete event. (Inherited from ServerBase)
OnSendClientDataException	Raises the SendClientDataException event. (Inherited from ServerBase)
OnSendClientDataStart	Raises the SendClientDataStart event. (Inherited from ServerBase)
OnServerStarted	Raises the ServerStarted event. (Inherited from ServerBase)
OnServerStopped	Raises the ServerStopped event. (Inherited from ServerBase)
Read	Reads a number of bytes from the current received data buffer and writes those bytes into a byte array at the specified offset. (Overrides ServerBaseRead(Guid, Byte, Int32, Int32))
ReStart	Re-starts the server if currently running. (Inherited from ServerBase)
SendDataToAsync	Sends data to the specified client asynchronously. (Overrides ServerBaseSendDataToAsync(Guid, Byte, Int32, Int32))
SendTo(Guid, Byte)	Sends data to the specified client synchronously. (Inherited from ServerBase)
SendTo(Guid, String)	Sends data to the specified client synchronously. (Inherited from ServerBase)
SendTo(Guid, Byte, Int32, Int32)	Sends data to the specified client synchronously. (Inherited from ServerBase)
SendToAsync(Guid, Byte)	Sends data to the specified client asynchronously. (Inherited from ServerBase)
SendToAsync(Guid, String)	Sends data to the specified client asynchronously. (Inherited from ServerBase)
SendToAsync(Guid, Byte, Int32, Int32)	Sends data to the specified client asynchronously. (Inherited from ServerBase)
Start	Starts the TcpServer synchronously and begins accepting client connections asynchronously. (Overrides ServerBaseStart)
Stop	Stops the TcpServer synchronously and disconnects all connected clients. (Overrides ServerBaseStop)
ToString	Returns a string that represents the current object. (Inherited from Object)
TryGetClient	Gets the TransportProviderT object associated with the specified client ID.
TryGetClientPrincipal	Gets the WindowsPrincipal object associated with the specified client ID.
ValidateConfigurationString	Validates the specified configurationString. (Overrides ServerBaseValidateConfigurationString(String))

Events

ClientConnected	Occurs when a client connects to the server. (Inherited from ServerBase)
ClientConnectingException	Occurs when an exception is encountered while a client is connecting. (Inherited from ServerBase)
ClientDisconnected	Occurs when a client disconnects from the server. (Inherited from ServerBase)
Disposed	Occurs when the ServerBase has been disposed. (Inherited from ServerBase)
ReceiveClientData	Occurs when unprocessed data has been received from a client. (Inherited from ServerBase)
ReceiveClientDataComplete	Occurs when data received from a client has been processed and is ready for consumption. (Inherited from ServerBase)
ReceiveClientDataException	Occurs when an Exception is encountered when receiving data from a client. (Inherited from ServerBase)
SendClientDataComplete	Occurs when data has been sent to a client. (Inherited from ServerBase)
SendClientDataException	Occurs when an Exception is encountered when sending data to a client. (Inherited from ServerBase)
SendClientDataStart	Occurs when data is being sent to a client. (Inherited from ServerBase)
ServerStarted	Occurs when the server is started. (Inherited from ServerBase)
ServerStopped	Occurs when the server is stopped. (Inherited from ServerBase)

Fields

DefaultAllowDualStackSocket	Specifies the default value for the AllowDualStackSocket property.
DefaultConfigurationString	Specifies the default value for the ConfigurationString property.
DefaultIgnoreInvalidCredentials	Specifies the default value for the IgnoreInvalidCredentials property.
DefaultIntegratedSecurity	Specifies the default value for the IntegratedSecurity property.
DefaultMaxSendQueueSize	Specifies the default value for the MaxSendQueueSize property.
DefaultNoDelay	Specifies the default value for the NoDelay property.
DefaultPayloadAware	Specifies the default value for the PayloadAware property.
DefaultTrustedCertificatesPath	Specifies the default value for the TrustedCertificatesPath property.