Editing SimTX API v24/Packets/TxQueue

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = TxQueue
| id = 4
| hex = 0x04
| direction = s2c
| session = [[SimTX API v24/Transmitter session|Transmitter]]
| size = 8 bytes
| permission = None
| answers = [[SimTX API v24/Packets/TransmitterSessionRequest|TransmitterSessionRequest]]
| group = transmitter
}}
'''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 [[SimTX API v24/Packets/TxAccept|TxAccept]].

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>4</code>.
|-
| <code>ahead</code> || <code>i32</code> || Number of requests ahead of this one. 0 means next in line.
|-
| <code>total</code> || <code>i32</code> || Total number of requests in the queue.
|}

== Usage ==
* 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 <code>session.queue_skip</code> permission are never queued. When the server is full they receive [[SimTX API v24/Packets/TxReject|TxReject]] with ''Server transmitter capacity reached'' instead.
* Closing the connection leaves the queue.

{{SimTX API v24 navbox}}
[[Category:SimTX API v24]]