SimTX API/Packets/KickResult: Difference between revisions

Latest revision as of 16:58, 24 October 2026

KickResult reports how many sessions a KickRequest disconnected.

message KickResult { int64 request_id = 1; int32 sessions_kicked = 2; }

#	Field	Type	Description
1	`request_id`	`int64`	The request this answers.
2	`sessions_kicked`	`int32`	Sessions disconnected. 0 if nothing matched.

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/KickResult]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = KickResult
+| frame = ServerFrame
+| field = 60
+| member = kick_result
+| direction = s2c
+| session = [[SimTX API/Moderation session|Moderation]]
+| roles = <code>ROLE_MODERATION</code>.
+| permission = None
+| answers = [[SimTX API/Packets/KickRequest|KickRequest]]
+| group = moderation
+| file = control.proto
+}}
+'''KickResult''' reports how many sessions a [[SimTX API/Packets/KickRequest|KickRequest]] disconnected.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message KickResult { int64 request_id = 1; int32 sessions_kicked = 2; }
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>request_id</code> || <code>int64</code> || The request this answers.
+|-
+| 2 || <code>sessions_kicked</code> || <code>int32</code> || Sessions disconnected. 0 if nothing matched.
+|}
+== See also ==
+* [[SimTX API/Moderation session]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]