|
Client
|
Represents a DataSubscriber client connection to the DataPublisher.
Inheritance Hierarchy
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta
Syntaxpublic class ClientConnection : IProvideStatus, IDisposable
The ClientConnection type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClientConnection | Creates a new ClientConnection instance. |
Properties| Name | Description | |
|---|---|---|
 | Authenticated | Gets or sets authenticated state of this ClientConnection. |
| CipherIndex | Gets current cipher index. |
| ClientID | Gets client ID of this ClientConnection. |
| ClientNotFoundExceptionOccurred | Gets or sets flag that indicates if the socket exception for "No client found for ID [Guid]" has been thrown. |
| CommandChannel | Gets IServer command channel. |
| ConnectionID | Gets the connection identification of this ClientConnection. |
| DataChannel | Gets or sets reference to UdpServer data channel, attaching to or detaching from events as needed, associated with this ClientConnection. |
| Encoding | Character encoding used to send messages to subscriber. |
| IPAddress | Gets the IP address of the remote client connection. |
| IsConnected | Gets connected state of the associated client socket. |
| IsSubscribed | Gets or sets IsSubscribed state. |
| KeyIVs | Gets active and standby keys and initialization vectors. |
| LastCipherKeyUpdateTime | Gets time of last cipher key update. |
| Name | Gets the subscriber name of this ClientConnection. |
| OperationalModes | Gets or sets a set of flags that define ways in which the subscriber and publisher communicate. |
| PublishChannel | Gets IServer publication channel - that is, data channel if defined otherwise command channel. |
| SharedSecret | Gets or sets shared secret used to lookup cipher keys only known to client and server. |
| Status | Gets a formatted message describing the status of this ClientConnection. |
| SubscriberAcronym | Gets or sets the subscriber acronym of this ClientConnection. |
| SubscriberID | Gets or sets the Guid based subscriber ID of this ClientConnection. |
| SubscriberInfo | Gets or sets subscriber info for this ClientConnection. |
| SubscriberName | Gets or sets the subscriber name of this ClientConnection. |
| Subscription | Gets or sets subscription associated with this ClientConnection. |
| ValidIPAddresses | Gets or sets the list of valid IP addresses that this client can connect from. |
Methods| Name | Description | |
|---|---|---|
| Dispose | Releases all the resources used by the ClientConnection object. |
 | Dispose(Boolean) | Releases the unmanaged resources used by the ClientConnection object and optionally releases the managed resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
Releases the unmanaged resources before the ClientConnection object is reclaimed by GC.
(Overrides ObjectFinalize) |
| GetCommandChannelSocket | Gets the Socket instance used by this client connection to send and receive data over the command channel. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| RotateCipherKeys | Rotates or initializes the crypto keys for this ClientConnection. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
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