SimTX API/Packets/StopMonitor: Difference between revisions

Revision as of 17:01, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

StopMonitor
Frame	`ClientFrame`, field 32
Member	`stop_monitor`
Direction	Client → server
Session	Control, moderation
Roles	`ROLE_CONTROL`, `ROLE_MODERATION`.
Permission	None
Answered by	MonitorAck
Answers
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

message StopMonitor { bytes session_id = 1; int64 request_id = 2; }

Fields

#	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

Complete frames, including the varint length prefix, from the protocol's golden test vectors (protocol/simtx/v25/testdata/frames.json).

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

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/StopMonitor]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = StopMonitor
+| frame = ClientFrame
+| field = 32
+| member = stop_monitor
+| direction = c2s
+| session = [[SimTX API/Control session|Control]], [[SimTX API/Moderation session|moderation]]
+| roles = <code>ROLE_CONTROL</code>, <code>ROLE_MODERATION</code>.
+| permission = None
+| reply = [[SimTX API/Packets/MonitorAck|MonitorAck]]
+| group = control
+| file = control.proto
+}}
+'''StopMonitor''' ends a monitor stream started with [[SimTX API/Packets/StartMonitor|StartMonitor]]. The server answers with [[SimTX API/Packets/MonitorAck|MonitorAck]] <code>active = false</code>, also when that monitor was not running. A few [[SimTX API/Packets/MonitorBlock|MonitorBlock]] frames already on their way may still arrive.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message StopMonitor { bytes session_id = 1; int64 request_id = 2; }
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>session_id</code> || <code>bytes</code> || 16-byte session id of the monitored transmitter.
+|-
+| 2 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/MonitorAck|MonitorAck]].
+|}
+== Example ==
+Complete frames, including the varint length prefix, from the protocol's golden test vectors (<code>protocol/simtx/v25/testdata/frames.json</code>).
+'''<code>stop_monitor</code>''' (client to server, 24 bytes):
+<syntaxhighlight lang="text">
+                     frame length 23
+02 14               stop_monitor (StopMonitor), 20 bytes
+A 10 AA AA AA AA …  session_id = aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee
+2D                request_id = 45
+</syntaxhighlight>
+== See also ==
+* [[SimTX API/Packets/StartMonitor|StartMonitor]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]