|
Tls
|
Represents a TCP-based communication client with SSL authentication and encryption.
Inheritance Hierarchy
SystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
GSF.CommunicationClientBase
GSF.CommunicationTlsClient
SystemMarshalByRefObject
System.ComponentModelComponent
GSF.CommunicationClientBase
GSF.CommunicationTlsClient
Namespace: GSF.Communication
Assembly: GSF.Communication (in GSF.Communication.dll) Version: 2.4.258-beta
Syntaxpublic class TlsClient : ClientBase
The TlsClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TlsClient | Initializes a new instance of the TlsClient class. |
| TlsClient(IContainer) | Initializes a new instance of the TlsClient class. |
| TlsClient(String) | Initializes a new instance of the TlsClient class. |
Properties| Name | Description | |
|---|---|---|
 | AllowDualStackSocket | Gets or sets a boolean value that determines if dual-mode socket is allowed when endpoint address is IPv6. |
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| Certificate | Gets or sets the local certificate selected by the default LocalCertificateSelectionCallback. |
| 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. |
| Client | Gets the Socket object for the TlsClient. |
| ClientCertificates | Gets the collection of X509 certificates for this client. |
| ConnectionString |
Gets or sets the data required by the client to connect to the server.
(Inherited from ClientBase) |
| ConnectionTime |
Gets the Time for which the client has been connected to the server.
(Inherited from ClientBase) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component) |
| CurrentState |
Gets the current ClientState.
(Inherited from ClientBase) |
| 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 client is currently enabled.
(Inherited from ClientBase) |
| EnabledSslProtocols | Gets or sets a set of flags which determine the enabled SslProtocols. |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| IgnoreInvalidCredentials | Gets or sets a boolean value that indicates whether the server should ignore errors when the client's credentials are invalid. |
| IntegratedSecurity | Gets or sets a boolean value that indicates whether the current Windows account credentials are used for authentication. |
| IsDisposed |
Gets a flag that indicates whether the object has been disposed.
(Inherited from ClientBase) |
| LocalCertificateSelectionCallback | Gets or sets the callback used to select a local certificate. |
| MaxConnectionAttempts |
Gets or sets the maximum number of times the client will attempt to connect to the server.
(Inherited from ClientBase) |
| MaxSendQueueSize | Gets or sets the maximum size for the send queue before payloads are dumped from the queue. |
| Name |
Gets the unique identifier of the client.
(Inherited from ClientBase) |
| NetworkCredential | Gets or sets network credential that is used when IntegratedSecurity is set to true. |
| 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. |
| PersistSettings |
Gets or sets a boolean value that indicates whether the client settings are to be saved to the config file.
(Inherited from ClientBase) |
| ReadIndex |
Gets or sets current read index for received data buffer incremented at each Read(Byte, Int32, Int32) call.
(Inherited from ClientBase) |
| ReceiveBufferSize |
Gets or sets the size of the buffer used by the client for receiving data from the server.
(Inherited from ClientBase) |
| RemoteCertificateValidationCallback | Gets or sets the callback used to verify remote certificates. |
| SendBufferSize |
Gets or sets the size of the buffer used by the client for sending data to the server.
(Inherited from ClientBase) |
| ServerIndex |
Gets the current server index, when multiple server end points are defined.
(Inherited from ClientBase) |
| ServerUri |
Gets the server URI of the TlsClient.
(Overrides ClientBaseServerUri) |
| SettingsCategory |
Gets or sets the category under which the client settings are to be saved to the config file if the PersistSettings property is set to true.
(Inherited from ClientBase) |
| Site | Gets or sets the ISite of the Component. (Inherited from Component) |
| SslStream | Gets the SslStream object for the TlsClient. |
| Statistics |
Gets the TransportStatistics for the client connection.
(Inherited from ClientBase) |
| Status |
Gets the descriptive status of the client.
(Overrides ClientBaseStatus) |
| TextEncoding |
Gets or sets the Encoding to be used for the text sent to the server.
(Inherited from ClientBase) |
| TrackStatistics |
Determines whether the base class should track statistics.
(Overrides ClientBaseTrackStatistics) |
| TransportProtocol |
Gets the TransportProtocol used by the client for the transportation of data with the server.
(Inherited from ClientBase) |
| 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| Name | Description | |
|---|---|---|
| BeginInit |
Performs necessary operations before the client properties are initialized.
(Inherited from ClientBase) |
| Connect |
Connects the client to the server synchronously.
(Inherited from ClientBase) |
| ConnectAsync |
Connects the TlsClient to the server asynchronously.
(Overrides ClientBaseConnectAsync) |
| 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) |
| Disconnect |
When overridden in a derived class, disconnects client from the server synchronously.
(Overrides ClientBaseDisconnect) |
| Dispose | Releases all resources used by the Component. (Inherited from Component) |
 | Dispose(Boolean) |
Releases the unmanaged resources used by the TlsClient and optionally releases the managed resources.
(Overrides ClientBaseDispose(Boolean)) |
| EndInit |
Performs necessary operations after the client properties are initialized.
(Inherited from ClientBase) |
| 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 client.
(Inherited from ClientBase) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadSettings |
Loads saved TlsClient settings from the config file if the PersistSettings property is set to true.
(Overrides ClientBaseLoadSettings) |
| 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) |
| OnConnectionAttempt |
Raises the ConnectionAttempt event.
(Inherited from ClientBase) |
| OnConnectionEstablished |
Raises the ConnectionEstablished event.
(Inherited from ClientBase) |
| OnConnectionException |
Raises the ConnectionException event.
(Inherited from ClientBase) |
| OnConnectionTerminated |
Raises the ConnectionTerminated event.
(Inherited from ClientBase) |
| OnReceiveData |
Raises the ReceiveData event.
(Inherited from ClientBase) |
| OnReceiveDataComplete |
Raises the ReceiveDataComplete event.
(Inherited from ClientBase) |
| OnReceiveDataException(Exception) |
Raises the ReceiveDataException event.
(Overrides ClientBaseOnReceiveDataException(Exception)) |
| OnReceiveDataException(SocketException) | Raises the ReceiveDataException event. |
| OnSendDataComplete |
Raises the SendDataComplete event.
(Inherited from ClientBase) |
| OnSendDataException |
Raises the SendDataException event.
(Overrides ClientBaseOnSendDataException(Exception)) |
| OnSendDataStart |
Raises the SendDataStart event.
(Inherited from ClientBase) |
| OnUnhandledUserException |
Raises the UnhandledUserException event.
(Inherited from ClientBase) |
| 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.
(Overrides ClientBaseRead(Byte, Int32, Int32)) |
| RequestNextServerIndex |
Requests that the client attempt to move to the next ServerIndex.
(Overrides ClientBaseRequestNextServerIndex) |
| SaveSettings |
Saves TlsClient settings to the config file if the PersistSettings property is set to true.
(Overrides ClientBaseSaveSettings) |
| Send(Byte) |
Sends data to the server synchronously.
(Inherited from ClientBase) |
| Send(Object) |
Sends data to the server synchronously.
(Inherited from ClientBase) |
| Send(String) |
Sends data to the server synchronously.
(Inherited from ClientBase) |
| Send(Byte, Int32, Int32) |
Sends data to the server synchronously.
(Inherited from ClientBase) |
| SendAsync(Byte) |
Sends data to the server asynchronously.
(Inherited from ClientBase) |
| SendAsync(Object) |
Sends data to the server asynchronously.
(Inherited from ClientBase) |
| SendAsync(String) |
Sends data to the server asynchronously.
(Inherited from ClientBase) |
| SendAsync(Byte, Int32, Int32) |
Sends data to the server asynchronously.
(Inherited from ClientBase) |
| SendDataAsync |
When overridden in a derived class, sends data to the server asynchronously.
(Overrides ClientBaseSendDataAsync(Byte, Int32, Int32)) |
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component) |
| UpdateBytesReceived |
Updates the Statistics pertaining to bytes received.
(Inherited from ClientBase) |
| UpdateBytesSent |
Updates the Statistics pertaining to bytes sent.
(Inherited from ClientBase) |
| ValidateConnectionString |
When overridden in a derived class, validates the specified connectionString.
(Overrides ClientBaseValidateConnectionString(String)) |
Events| Name | Description | |
|---|---|---|
 | ConnectionAttempt |
Occurs when client is attempting connection to the server.
(Inherited from ClientBase) |
| ConnectionEstablished |
Occurs when client connection to the server is established.
(Inherited from ClientBase) |
| ConnectionException |
Occurs when an Exception is encountered during connection attempt to the server.
(Inherited from ClientBase) |
| ConnectionTerminated |
Occurs when client connection to the server is terminated.
(Inherited from ClientBase) |
| Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component) |
| ReceiveData |
Occurs when unprocessed data has been received from the server.
(Inherited from ClientBase) |
| ReceiveDataComplete |
Occurs when data received from the server has been processed and is ready for consumption.
(Inherited from ClientBase) |
| ReceiveDataException |
Occurs when an Exception is encountered when receiving data from the server.
(Inherited from ClientBase) |
| SendDataComplete |
Occurs when the client has successfully sent data to the server.
(Inherited from ClientBase) |
| SendDataException |
Occurs when an Exception is encountered when sending data to the server.
(Inherited from ClientBase) |
| SendDataStart |
Occurs when the client begins sending data to the server.
(Inherited from ClientBase) |
| UnhandledUserException |
Occurs when an Exception is encountered in a user-defined function via an event dispatch.
(Inherited from ClientBase) |
Fields| Name | Description | |
|---|---|---|
  | DefaultAllowDualStackSocket | Specifies the default value for the AllowDualStackSocket property. |
| DefaultConnectionString | Specifies the default value for the ConnectionString 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. |
Extension Methods| 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) |
See Also