SimTX API/Packets/MonitorEnd: Difference between revisions

Revision as of 17:00, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

MonitorEnd
Frame	`ServerFrame`, field 32
Member	`monitor_end`
Direction	Server → client
Session	Control, moderation
Roles	`ROLE_CONTROL`, `ROLE_MODERATION`.
Permission	None
Answered by
Answers
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

message MonitorEnd {
  bytes session_id = 1;
  string reason = 2;
}

Fields

#	Field	Type	Description
1	`session_id`	`bytes`	The transmitter.
2	`reason`	`string`	Human-readable reason, for example Transmitter went off the air.

Reasons

Reason	Meaning
Transmitter went off the air	The monitored session ended.
Shard connection ended	Through the public gateway: the server node hosting the transmitter became unreachable.

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/Packets/MonitorEnd]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = MonitorEnd
+| frame = ServerFrame
+| field = 32
+| member = monitor_end
+| direction = s2c
+| session = [[SimTX API/Control session|Control]], [[SimTX API/Moderation session|moderation]]
+| roles = <code>ROLE_CONTROL</code>, <code>ROLE_MODERATION</code>.
+| permission = None
+| group = control
+| file = 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 [[SimTX API/Packets/Error|Error]] instead, and one stopped by the client with [[SimTX API/Packets/MonitorAck|MonitorAck]].
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message MonitorEnd {
+  bytes session_id = 1;
+  string reason = 2;
+}
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>session_id</code> || <code>bytes</code> || The transmitter.
+|-
+| 2 || <code>reason</code> || <code>string</code> || Human-readable reason, for example <i>Transmitter went off the air</i>.
+|}
+== Reasons ==
+{| class="wikitable"
+! Reason !! Meaning
+|-
+| ''Transmitter went off the air'' || The monitored session ended.
+|-
+| ''Shard connection ended'' || Through the public gateway: the server node hosting the transmitter became unreachable.
+|}
+== See also ==
+* [[SimTX API/Packets/StartMonitor|StartMonitor]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]