Login Response Message Fields

A Login Response message is sent in response to a Login Request message. On a successful login, the LoginResponseStatus will be set to A. On a failed login, LoginResponseStatus will be set to a value other than A, and LoginResponseText will be set to an appropriate failure description.

Note that the repeating group starting with field UnitNumber provides the highest available Cboe to member sequence number for the specified unit. For unitized ports, only the unit of the port will populate this group (i.e., NumberOfUnits will be 1).

Table 1. Login Response Message Fields
Field NameOffsetLengthData TypeDescription
StartOfMessage02Binary B0 E3 (58288)
MessageLength22Binary(76 + NumberOfUnits*5)
MessageType42Binary F5 01 (501)
MatchingUnit61BinaryWill be zero
Reserved71BinaryUnspecified
SequenceNumber84BinaryWill be zero
LoginResponseStatus121Text
  • Accepted, or the reason for the rejection.
  • A = Accepted
  • B = Session In Use
  • D = Disabled
  • I = Invalid Unit
  • M = Invalid Message
  • N = Not Authorized
  • Q = Sequence Ahead
  • R = Replay too Deep
  • S = Invalid Session
  • X = Invalid replay instruction
LoginResponseText1360TextHuman-readable text with additional information about the reason for rejection. ASCII NUL (0x00) filled on the right, if necessary.
ClientSequence734BinaryLast inbound (member to Cboe) message sequence number processed by Cboe on this port.
NumberOfUnits771BinaryA number, n, of unit/sequence pairs to follow, one per unit. A pair for every unit will be sent, even if no messages have been sent to this port today. For logins having LoginResponseStatus other than A, Q, or R, this will be 0.
→UnitNumber781BinaryA unit number
→UnitSequence794BinaryHighest available Cboe to member sequence number for the unit.
Cboe Titanium U.S. Options BOEv3 Specification | Cboe