3.4.1.3 Message: CloseSession
| Topic Version | 1 | Published | 10/31/2016 | |
| For Standard | ETP v1.1 | |||
Sent from either a client or server to close the current session. The receiver of this message MUST respond by doing a clean shutdown of the WebSocket connection.
In general, CloseSession can be sent at any time, for any reason, by either the client or the server. In a situation where an error condition causes the agent to close the session, then the associated ProtocolException MUST be sent prior to the CloseSession.
Message Type ID: 5
Correlation Id Usage: n/a
Multi-part: False
Sent by: client,server
|
Attribute |
Description |
Data Type |
Min |
Max |
|---|---|---|---|---|
|
reason |
The reason for requesting the session be closed. |
string |
0 |
1 |
|
Avro Source |
|---|
|
{ "type": "record", "namespace": "Energistics.Protocol.Core", "name": "CloseSession", "messageType": "5", "protocol": "0", "senderRole": "client,server", "protocolRoles": "client,server", "fields": [ { "name": "reason", "type": ["null", "string"] } ] } |