SimTX API/Packets/TxQueue

TxQueue

Frame	ServerFrame, field 13
Member	tx_queue
Direction	Server → client
Session	Transmitter
Roles	ROLE_TX_AUDIO, ROLE_TX_GENERATED.
Permission	None
Answered by
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

message TxQueue {
  int32 ahead = 1;
  int32 total = 2;
}

Fields

#	Field	Type	Description
1	ahead	int32	Requests ahead of this one. 0 means next in line.
2	total	int32	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 session.queue_skip are never queued. When the server is full they get SessionStatus REJECTED LIMIT_REACHED instead.
• Closing the connection leaves the queue.

See also

• Admission