|
Operational
|
Operational modes that affect how DataPublisher and DataSubscriber communicate.
Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.282-beta
Syntax[FlagsAttribute] public enum OperationalModes
Members| Member name | Value | Description |
|---|---|---|
| NoFlags | 0 | No flags set. |
| VersionMask | 31 | Mask to get version number of protocol. |
| CompressionModeMask | 224 | Mask to get mode of compression. |
| EncodingMask | 768 | Mask to get character encoding used when exchanging messages between publisher and subscriber. |
| UseCommonSerializationFormat | 16,777,216 | Determines type of serialization to use when exchanging signal index cache and metadata. |
| ReceiveExternalMetadata | 33,554,432 | Determines whether external measurements are exchanged during metadata synchronization. |
| ReceiveInternalMetadata | 67,108,864 | Determines whether internal measurements are exchanged during metadata synchronization. |
| CompressPayloadData | 536,870,912 | Determines whether payload data is compressed when exchanging between publisher and subscriber. |
| CompressSignalIndexCache | 1,073,741,824 | Determines whether the signal index cache is compressed when exchanging between publisher and subscriber. |
| CompressMetadata | 2,147,483,648 | Determines whether metadata is compressed when exchanging between publisher and subscriber. |
The OperationalModes type exposes the following members.
Extension Methods| Name | Description | |
|---|---|---|
 | GetDescription |
Retrieves the description of the value that this Enum represents extracted from the DescriptionAttribute, or the enumeration name
if no description is available.
(Defined by EnumExtensions) |
| GetFormattedName |
Retrieves a formatted name of the value that this Enum represents for visual display.
(Defined by EnumExtensions) |
Remarks
Operational modes are sent from a subscriber to a publisher to request operational behaviors for the
connection, as a result the operation modes must be sent before any other command. The publisher may
silently refuse some requests (e.g., compression) based on its configuration. Operational modes only
apply to fundamental protocol control.
See Also