Message: RestoreOrJoinSession

File: WebAPI/user_session_2.proto

Description

Client request to restore session because of accidental disconnect or to join additional concurrent connection to existing session. This message allows to avoid prompting user for (one-time) password. In case of session restore client application has to (re-)subscribe and (re-)request necessary data. Permissions to use this functionality is regulated by ALLOW_SESSION_RESTORE/ALLOW_SESSION_JOIN session settings which are specified in Logon or LogonInit message.

Limits: The number of concurrent joined sessions is 10 by default.

Response: RestoreOrJoinSessionResult.

Used in

ClientMsg

Fields

session_token

Type: string

Description: Token of the session to restore/join, it has limited lifetime after disconnecting of the last connection.

Source: LogonResult.session_token.

private_label

Type: string

Description: Private label identifies the Firm or Vendor that connects to the server, client_app_id field value is taken by default.

client_app_id

Type: string

Description: Identifier of the client application as assigned by CQG. This field is required to be specified and left optional only for backward compatibility.

max_collapsing_level

Type: uint32

Description: Maximum allowed real-time market data collapsing level. REAL_TIME_COLLAPSING_LEVEL_DOM_BBA_TRADES is the default allowed collapsing level. This field is associated with the RealTimeCollapsingLevel enum type. Only one of max_collapsing_level and market_data_bandwidth can be specified.

Source: RealTimeCollapsingLevel.

market_data_bandwidth

Type: uint32

Description: Real-time market data bandwidth limit (in KB per second). Only one of max_collapsing_level and market_data_bandwidth can be specified.

protocol_version_minor

Type: uint32

Description: Current protocol version that is used by the client application. It is strongly recommended for client applications to put PROTOCOL_VERSION_MAJOR and PROTOCOL_VERSION_MINOR values from a used protocol file. If version information is not provided, then the server assumes client uses 0.x version of the protocol and may disable some new protocol features.

Source: ProtocolVersionMinor.

protocol_version_major

Type: uint32

Description: See: protocol_version_minor

Source: ProtocolVersionMajor.