3.4.1.2 Message: OpenSession
| Topic Version | 1 | Published | 10/31/2016 | |
| For Standard | ETP v1.1 | |||
A positive response from the server to the RequestSession message, providing the session ID and supported subprotocols.
Message Type ID: 2
Correlation Id Usage:
MUST contain the message id of the RequestSession message that resulted in this session being created.
Multi-part: False
Sent by: server
|
Attribute |
Description |
Data Type |
Min |
Max |
|---|---|---|---|---|
|
applicationName |
The string by which the server identifies itself. This may or may not include a version, and is entirely application dependent. Vendors are encouraged to identify their company name as part of this string. |
string |
1 |
1 |
|
applicationVersion |
string |
1 |
1 |
|
|
sessionId |
An identifier for this session. This must be a UUID as specified by RFC 4122. The UUID must be formatted as a string, in the form commonly known as "Windows Registry format", without the enclosing curly braces. Example: 65CCC68E-C0B4-454E-8757-3284F94AE861 |
string |
1 |
1 |
|
supportedProtocols |
An array of SupportedProtocols, representing the requested protocols that are actually supported by the server. |
SupportedProtocol |
1 |
n |
|
supportedObjects |
See the documentation for ServerCapabilities record for a description of this field. |
string |
1 |
n |
|
Avro Source |
|---|
|
{ "type": "record", "namespace": "Energistics.Protocol.Core", "name": "OpenSession", "messageType": "2", "protocol": "0", "senderRole": "server", "protocolRoles": "client,server", "fields": [ { "name": "applicationName", "type": "string" }, { "name": "applicationVersion", "type": "string" }, { "name": "sessionId", "type": "string" }, { "name": "supportedProtocols", "type": { "type": "array", "items": "Energistics.Datatypes.SupportedProtocol" } }, { "name": "supportedObjects", "type": { "type": "array", "items": "string" } } ] } |