Struct LoginQueuePositionBroadcast

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Broadcast sent by the LoginServer to a queued client with their current position in the login queue. Sent periodically at a server-configured rate.

Position semantics:

• > 0 — Waiting in queue. Display the position to the user.
• 0 — Admitted. The client should re-initiate the handshake now.
• -1 — Cancelled. The queue entry was purged (timeout or shutdown).

Server-authoritative update rate: The server controls how often this broadcast is sent via the LoginQueueUpdateRateSeconds config key. Clients are passive receivers only — there is no request path for faster updates.

Validation: The server MUST enforce the documented QueuePosition semantics (>0 waiting, 0 admitted, -1 cancelled). The client treats these values as authoritative — no local defensive validation is performed.

public struct LoginQueuePositionBroadcast : IBroadcast

Implements

IBroadcast

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

EstimatedWaitSeconds

Rough estimated wait time in seconds based on the server's admission rate. 0 if unknown or if the client has been admitted.

public int EstimatedWaitSeconds

Field Value

int

QueuePosition

Current 1-based queue position. 0 = admitted, -1 = cancelled.

public int QueuePosition

Field Value

int

TotalQueued

Total number of clients currently in the queue.

public int TotalQueued

Field Value

int