SimTX API/Packets/TxQueue: Difference between revisions
Clanker moved page SimTX API/Packets/TxQueue to SimTX API v24/Packets/TxQueue: Archive the v24 protocol reference Tag: New redirect |
Protocol v25 reference: TxQueue Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
# | {{SimTX API navigation}} | ||
{{SimTX packet | |||
| name = TxQueue | |||
| frame = ServerFrame | |||
| field = 13 | |||
| member = tx_queue | |||
| direction = s2c | |||
| session = [[SimTX API/Transmitter session|Transmitter]] | |||
| roles = <code>ROLE_TX_AUDIO</code>, <code>ROLE_TX_GENERATED</code>. | |||
| permission = None | |||
| answers = [[SimTX API/Packets/TransmitterStart|TransmitterStart]] | |||
| group = transmitter | |||
| file = session.proto | |||
}} | |||
'''TxQueue''' tells a transmitter client that every transmitter slot on the server is taken and that its start is waiting in line. The server sends it after [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>BOUND</code> when the start enters the queue, and again whenever the position changes, at most about once a second, until it sends [[SimTX API/Packets/TxAccept|TxAccept]]. | |||
== Definition == | |||
<syntaxhighlight lang="protobuf"> | |||
message TxQueue { | |||
int32 ahead = 1; | |||
int32 total = 2; | |||
} | |||
</syntaxhighlight> | |||
== Fields == | |||
{| class="wikitable" | |||
! # !! Field !! Type !! Description | |||
|- | |||
| 1 || <code>ahead</code> || <code>int32</code> || Requests ahead of this one. 0 means next in line. | |||
|- | |||
| 2 || <code>total</code> || <code>int32</code> || 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 <code>session.queue_skip</code> are never queued. When the server is full they get [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>REJECTED</code> <code>LIMIT_REACHED</code> instead. | |||
* Closing the connection leaves the queue. | |||
== See also == | |||
* [[SimTX API/Transmitter session#Admission|Admission]] | |||
{{SimTX API navbox}} | |||
[[Category:SimTX API]] | |||
Latest revision as of 17:01, 24 October 2026
| Frame | ServerFrame, field 13
|
|---|---|
| Member | tx_queue
|
| Direction | Server → client |
| Session | Transmitter |
| Roles | ROLE_TX_AUDIO, ROLE_TX_GENERATED.
|
| Permission | None |
| Answers | TransmitterStart |
| Defined in | session.proto
|
TxQueue tells a transmitter client that every transmitter slot on the server is taken and that its start is waiting in line. The server sends it after SessionStatus BOUND when the start enters the queue, and again whenever the position changes, at most about once a second, until it sends TxAccept.
Definition[edit | edit source]
message TxQueue {
int32 ahead = 1;
int32 total = 2;
}
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | ahead |
int32 |
Requests ahead of this one. 0 means next in line. |
| 2 | total |
int32 |
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
session.queue_skipare never queued. When the server is full they get SessionStatusREJECTEDLIMIT_REACHEDinstead. - Closing the connection leaves the queue.