Login Request
A Login Request message must be sent as the first message upon connection.
The message includes a repeating group starting with field UnitNumber which repeats NumberOfUnits times. This can be used to specify the last consumed sequence numbers per matching unit received by the TPH. CFE uses these sequence numbers to determine what outbound (CFE to TPH) traffic, if any, was missed by the TPH. If NumberOfUnits is 0, it is assumed the TPH has not received any messages (e.g., start of day).
The TPH does not need to include a sequence number for a unit if they never received messages from it. If the TPH wishes to send a value for the unit anyway, 0 is the only allowed value.
If the TPH is sending a Login Request to a Unit Order Port, Unit Quoting Port, or Unit Purge Port, the only UnitNumber accepted is the number of the port's unit.
| Field Name | Offset | Length | Data Type | Description |
|---|---|---|---|---|
| StartOfMessage | 0 | 2 | Binary |
B0 E3 (58288) |
| MessageLength | 2 | 2 | Binary | (30 + 5*NumberOfUnits) |
| MessageType | 4 | 2 | Binary |
01 00 (1) |
| MatchingUnit | 6 | 1 | Binary | Must be zero |
| Reserved | 7 | 1 | Binary | Must be zero |
| SequenceNumber | 8 | 4 | Binary | Must be zero |
| SessionId | 12 | 4 | AlphaNumeric | Session Id as supplied by CFE |
| SessionSubId | 16 | 4 | AlphaNumeric | Session Sub Id as supplied by CFE |
| Password | 20 | 10 | AlphaNumeric | The password associated with the SessionId and SessionSubId. |
| ReplayUnspecifiedUnit | 30 | 1 | Text |
|
| NumberOfUnits | 31 | 1 | Binary | The number (possibly 0) of unit/sequence pairs to follow, one per unit from which the TPH has received messages over this port. The value must be 0 or 1 since all BOEv3 ports are associated to a single unit. |
| →UnitNumber | 32 | 1 | Binary | A unit number. This must be the unit number of the port. |
| →UnitSequence | 33 | 4 | Binary | Last received sequence number for the unit. |