3.4.2.8 Message: ChannelRemove
| Topic Version | 1 | Published | 10/31/2016 | |
| For Standard | ETP v1.1 | |||
Sent from a producer to a consumer to indicate that a channel is no longer actively streaming data. Once a channel has been removed, a producer MUST NOT send additional ChannelData messages on this channel. At this point, the channel's ID is retired for the remainder of the session. A producer MAY reactivate a channel with the same URI.
Optionally, use removeReason to specify a human-readable description of why the channel was removed.
Message Type ID: 8
Correlation Id Usage: n/a
Multi-part: False
Sent by: producer
|
Attribute |
Description |
Data Type |
Min |
Max |
|---|---|---|---|---|
|
channelId |
The ID of the channel to be deleted. |
long |
1 |
1 |
|
removeReason |
An optional human-readable description of why the channel is being removed. |
string |
0 |
1 |
|
Avro Source |
|---|
|
{ "type": "record", "namespace": "Energistics.Protocol.ChannelStreaming", "name": "ChannelRemove", "messageType": "8", "protocol": "1", "senderRole": "producer", "protocolRoles": "producer,consumer", "fields": [ { "name": "channelId", "type": "long" }, { "name": "removeReason", "type": ["null", "string"] } ] } |