2.2.3.1 Methods for Interface IChannelStreamingProducer

Topic Version1Published10/31/2016
For StandardETP v1.1

Method

Description

Type

Parameter Summary

channelMetadata

Sent from a producer to a consumer to describe channels that may be streamed to the consumer in future messages.

 

(in) eventData: ChannelMetadata

onChannelRangeRequest

Sent from a consumer to a producer to request data over a specific range for one or more channels.

event

(in) eventData: ChannelRangeRequest

onStart

Start the protocol. For a SimpleStreamer, this message indicates it should start streaming data. Includes parameters to throttle size and rate of messages.

event

(in) eventData: Start

onChannelStreamingStart

Sent from a consumer to a producer to request that the producer begin streaming one or more channels.

event

(in) eventData: ChannelStreamingStart

onChannelStreamingStop

Sent from a consumer to a producer to request that streaming be discontinued on one or more channels.

event

(in) eventData: ChannelStreamingStop

onChannelDescribe

Sent from consumer to a producer to request metadata about one or more channels, specified by URI.

event

(in) eventData: ChannelDescribe

channelDataChange

Sent from a producer to a consumer to notify the consumer of changed date points on the channel.

 

(in) eventData: ChannelDataChange

channelRemove

Sent from a producer to a consumer to indicate that a channel is no longer actively streaming data.

 

(in) eventData: ChannelDelete

channelStatusChange

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 inChannelStreamingInfo record used to start this channel is set to True.

 

(in) eventData: ChannelStatusChange

channelData

Contains an array of <index,value> 2 tuples for one or more channels.

 

(in) eventData: ChannelData