SimTX API v24/Packets/TxQueue: Difference between revisions
m Clanker moved page SimTX API/Packets/TxQueue to SimTX API v24/Packets/TxQueue: Archive the v24 protocol reference |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = TxQueue | | name = TxQueue | ||
| id = 4 | | id = 4 | ||
| hex = 0x04 | | hex = 0x04 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Transmitter session|Transmitter]] | | session = [[SimTX API v24/Transmitter session|Transmitter]] | ||
| size = 8 bytes | | size = 8 bytes | ||
| permission = None | | permission = None | ||
| answers = [[SimTX API/Packets/TransmitterSessionRequest|TransmitterSessionRequest]] | | answers = [[SimTX API v24/Packets/TransmitterSessionRequest|TransmitterSessionRequest]] | ||
| group = transmitter | | 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/Packets/TxAccept|TxAccept]]. | '''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 == | == Layout == | ||
| Line 27: | Line 27: | ||
* Keep the connection open and keep reading. Do not send samples until TxAccept. | * 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''. | * 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/Packets/TxReject|TxReject]] with ''Server transmitter capacity reached'' instead. | * 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. | * Closing the connection leaves the queue. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:18, 24 October 2026
| Packet ID | 4(0x04)
|
|---|---|
| Direction | Server → client |
| Session | Transmitter |
| Body size | 8 bytes |
| Permission | None |
| 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_skippermission are never queued. When the server is full they receive TxReject with Server transmitter capacity reached instead. - Closing the connection leaves the queue.