2.2.2.1 Methods for Interface IChannelStreamingConsumer
Topic Version | 1 | Published | 10/31/2016 | |
For Standard | ETP v1.1 |
Method |
Description |
Type |
Parameter Summary |
---|---|---|---|
start |
Start the protocol. For a SimpleStreamer, this message indicates it should start streaming data. |
(in) eventData: Start |
|
channelDescribe |
Sent from a consumer to a producer to request metadata about one or more channels, specified by URI. |
(in) eventData: ChannelDescribe |
|
channelStreamingStart |
Sent from a consumer to a producer to request that the producer begin streaming one or more channels. |
(in) eventData: ChannelStreamingStart |
|
channelStreamingStop |
Sent from a consumer to a producer to request that streaming be discontinued on one or more channels. |
(in) eventData: ChannelStreamingStop |
|
channelRangeRequest |
Sent from a consumer to a producer to request data over a specific range for one or more channels. |
(in) eventData: ChannelRangeRequest |
|
onChannelMetadata |
Sent from a producer to a consumer to describe channels that may be streamed to the consumer in future messages. |
event |
(in) eventData: ChannelMetadata |
onChannelData |
Contains an array of <index,value> 2-tuples for one or more channels. |
event |
(in) eventData: ChannelData |
onChannelRemove |
Sent from a producer to a consumer to indicate that a channel is no longer actively streaming data. When a channel has been removed, a producer MUST NOT send additional ChannelData messages on this channel. ChannelRemove is sent regardless of the value of receiveChangeNotification field in the ChannelStreamingInfo record used to start this channel. |
event |
(in) eventData: ChannelRemove |
onChannelDataChange |
Sent from a producer to a consumer to notify the consumer of changed data points on the channel. Only sent if the receiveChangeNotification field in ChannelStreamingInfo record used to start this channel is set to True. |
event |
(in) eventData: ChannelDataChange |
onChannelStatusChange |
Sent from a producer to a consumer when the status of a channel (as defined in the status field of the ChannelMetadataRecord) has changed. Only sent if the recieveChangeNotification field in ChannelStreamingInfo record used to start this channel is set to True. |
event |
(in) eventData: ChannelStatusChange |