A PassingRequest requests old and/or future passings or requests the stream of passings to stop.
It also allows to acknowledge received passings.
Sending a new get request will stop any other ongoing get request in the stream.
| Field | Type | Label | Description |
| get | CmdGetPassings |
request passings |
|
| stop | CmdStopPassings |
stop the current stream of passings |
|
| ack | CmdAckPassing |
acknowledge received passings |
CmdGetPassings
CmdGetPassings
CmdGetPassings requests past and/or future passings from an Ubidium.
| Field | Type | Label | Description |
| start_ref | CmdGetPassings.StartReference |
start with the given StartReference |
|
| no | Passing.No |
start with the given passing (and file) number |
|
| id | uint64 |
start with the given passing ID |
|
| end_ref | CmdGetPassings.EndReference |
stop when the given EndReference is reached |
|
| count | uint32 |
stop when at most count passings have been sent |
CmdGetPassings.StartReference
| Name | Number | Description |
| START_REFERENCE_UNSPECIFIED | 0 |
|
| START_REFERENCE_NOW | 1 |
request only new passings from the time the request is processed by an Ubidium |
| START_REFERENCE_BEGINNING_OF_CURRENT_FILE | 2 |
request passings starting with the beginning of the current file |
| START_REFERENCE_BEGINNING_OF_FIRST_FILE | 3 |
request passings starting with the beginning of the first existing file |
CmdGetPassings.EndReference
| Name | Number | Description |
| END_REFERENCE_UNSPECIFIED | 0 |
|
| END_REFERENCE_UNTIL_STOPPED | 1 |
request passings until told so explicitly with a CmdStopPassings |
| END_REFERENCE_CURRENTLY_EXISTING | 2 |
request passings until the newest passing known when the request is processed by an Ubidium |
| END_REFERENCE_END_OF_FILE | 3 |
request passings until the end of file that corresponds to start |
CmdStopPassings
CmdStopPassings tells the Ubidium to stop sending passings
CmdAckPassing
Using CmdAckPassing one can confirm that passings until the given one were received and processed.
This is currently only used to display the progress bar on the Ubidium when working with a TimingServer.
| Field | Type | Label | Description |
| id | uint64 |
passing ID of the latest processed passing |
|
| no | Passing.No |
passing (and file) number of the latest processed passing |