Message: LoggedOff

File: WebAPI/user_session_2.proto

Description

Server notification about closing user’s session; the server closes the connection after this message.

Request: Logoff.

Used in

ServerMsg

Fields

logoff_reason

Type: uint32

Description: One of the logoff reasons. This field is associated with the LogoffReason enum type.

forced_logoff_reason

Type: uint32

Description: This field is associated with the ForcedLogoffReason enum type.

text_message

Type: string

Description: Optional logoff details.

redirect_url

Type: string

Description: URL for redirection.

Enum LogoffReason

Values

      LOGOFF_REASON_BY_REQUEST = 1

     User is logged off by client request.

      LOGOFF_REASON_REDIRECTED = 2

     User is redirected to another URL.

      LOGOFF_REASON_FORCED = 3

     System logged off the user because of some server side reason.

      LOGOFF_REASON_REASSIGNED = 4

     System logged off the user because this session was re-assigned to another connection that took it over by ‘restore session’ operation.

Enum ForcedLogoffReason

Values

      FORCED_LOGOFF_REASON_UNDEFINED = 0

     Undefined forced logoff reason.

      FORCED_LOGOFF_REASON_DEMO_LOGIN_EXPIRED = 1

     Demo login has expired.

      FORCED_LOGOFF_REASON_CONCURRENT_SESSION_LOGGED = 2

     Trader has performed another logon with drop_concurrent_session=true (see Logon, LogonInit messages) and client application type doesn’t allow concurrency.

      FORCED_LOGOFF_REASON_CAST = 3

     Trader session has been terminated from CAST.