Jump to content

SimTX API v24/Packets/TxQueue

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
TxQueue
Packet ID 4(0x04)
Direction Server → client
Session Transmitter
Body size 8 bytes
Permission None
Answered by
Answers TransmitterSessionRequest

TxQueue tells a transmitter client that every transmitter slot on the server is taken and that its request is waiting in line. The server sends it when the request enters the queue, and again whenever the position changes, at most about once a second, until it sends TxAccept.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 4.
ahead i32 Number of requests ahead of this one. 0 means next in line.
total i32 Total number of requests in the queue.

Usage[edit | edit source]

  • Keep the connection open and keep reading. Do not send samples until TxAccept.
  • Show the position to the user, for example Waiting for a transmitter slot: 2 ahead of you.
  • Accounts with the session.queue_skip permission are never queued. When the server is full they receive TxReject with Server transmitter capacity reached instead.
  • Closing the connection leaves the queue.
SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference