SimTX API/Packets/StopMonitor
Appearance
| Frame | ClientFrame, field 32
|
|---|---|
| Member | stop_monitor
|
| Direction | Client → server |
| Session | Control, moderation |
| Roles | ROLE_CONTROL, ROLE_MODERATION.
|
| Permission | None |
| Answered by | MonitorAck |
| Defined in | control.proto
|
StopMonitor ends a monitor stream started with StartMonitor. The server answers with MonitorAck active = false, also when that monitor was not running. A few MonitorBlock frames already on their way may still arrive.
Definition[edit | edit source]
message StopMonitor { bytes session_id = 1; int64 request_id = 2; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | session_id |
bytes |
16-byte session id of the monitored transmitter. |
| 2 | request_id |
int64 |
Nonzero; echoed in the MonitorAck. |
Example[edit | edit source]
Complete frames, including the varint length prefix.
stop_monitor (client to server, 24 bytes):
17 frame length 23
82 02 14 stop_monitor (StopMonitor), 20 bytes
0A 10 AA AA AA AA … session_id = aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee
10 2D request_id = 45