 | Subscribe |
*
A request used to subscribe to live data in order to get the data when updated.
Inheritance HierarchyNamespace: Canary.Views.Grpc.Api
Assembly: Canary.Views.Grpc.Api (in Canary.Views.Grpc.Api.dll) Version: 25.6.0.25344+3070493948bf7d32a86bd3e9a8bcf4cc9a5b1929
SyntaxC#
public sealed class SubscribeToLiveDataRequest : IMessage<SubscribeToLiveDataRequest>, IMessage, IEquatable<SubscribeToLiveDataRequest>, IDeepCloneable<SubscribeToLiveDataRequest>, IBufferMessage
The SubscribeToLiveDataRequest type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SubscribeToLiveDataRequest | Initializes a new instance of the SubscribeToLiveDataRequest class |
| SubscribeToLiveDataRequest(SubscribeToLiveDataRequest) | Initializes a new instance of the SubscribeToLiveDataRequest class |
Properties| Name | Description | |
|---|---|---|
 | BrowsePaths | The views paths to browse for tags and then subscribe. |
| Cci | The client connection ID associated with the connection. |
 | Descriptor | |
| IsAnnotationsEnabled | Whether or not to return annotations. |
| IsCompressionEnabled | Whether or not to compress the data. If false and the service has compression enabled, disables compression for returned values (may be faster). |
| IsLastestValueOnly | Whether or not to only return the latest value. This is more efficient when true, but could miss values in the middle of the reporting interval. |
| IsTagAliasingEnabled | Whether or not to use tag aliasing. If true, aliases are returned on the first message sent and subsequent messages use the aliases for smaller payloads. |
| IsVirtualTimeExtensionEnabled | Whether or not to enable time extension. If true, then values are virtually time extended during each reporting interval call, regardless of whether the values or timestamp changed. |
| Parser | |
| ReportingInterval | The interval to return data in. |
| TagPathNormalizationBehavior | Normalization behavior for the tag paths returned in response messages. |
| Tags | The tags that include the view to subscribe to. |
Methods| Name | Description | |
|---|---|---|
| CalculateSize | |
| Clone | |
| Equals(Object) | (Overrides ObjectEquals(Object)) |
| Equals(SubscribeToLiveDataRequest) | |
| GetHashCode | (Overrides ObjectGetHashCode) |
| MergeFrom(CodedInputStream) | |
| MergeFrom(SubscribeToLiveDataRequest) | |
| ToString | (Overrides ObjectToString) |
| WriteTo |
Fields| Name | Description | |
|---|---|---|
 | BrowsePathsFieldNumber | Field number for the "browse_paths" field. |
| CciFieldNumber | Field number for the "cci" field. |
| IsAnnotationsEnabledFieldNumber | Field number for the "is_annotations_enabled" field. |
| IsCompressionEnabledFieldNumber | Field number for the "is_compression_enabled" field. |
| IsLastestValueOnlyFieldNumber | Field number for the "is_lastest_value_only" field. |
| IsTagAliasingEnabledFieldNumber | Field number for the "is_tag_aliasing_enabled" field. |
| IsVirtualTimeExtensionEnabledFieldNumber | Field number for the "is_virtual_time_extension_enabled" field. |
| ReportingIntervalFieldNumber | Field number for the "reporting_interval" field. |
| TagPathNormalizationBehaviorFieldNumber | Field number for the "tag_path_normalization_behavior" field. |
| TagsFieldNumber | Field number for the "tags" field. |
See Also