SimTX API/Packets/MonitorEnd
Appearance
| Frame | ServerFrame, field 32
|
|---|---|
| Member | monitor_end
|
| Direction | Server → client |
| Session | Control, moderation |
| Roles | ROLE_CONTROL, ROLE_MODERATION.
|
| Permission | None |
| Defined in | control.proto
|
MonitorEnd tells the client that the server ended a running monitor stream, for example because the transmitter went off the air. A monitor that cannot be started is answered with Error instead, and one stopped by the client with MonitorAck.
Definition[edit | edit source]
message MonitorEnd {
bytes session_id = 1;
string reason = 2;
}
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | session_id |
bytes |
The transmitter. |
| 2 | reason |
string |
Human-readable reason, for example Transmitter went off the air. |
Reasons[edit | edit source]
| Reason | Meaning |
|---|---|
| Transmitter went off the air | The monitored session ended. |
| Shard connection ended | The server hosting the transmitter became unreachable. |