Interface MatchmakingQueue

interface MatchmakingQueue {
    get size(): number;
    add(candidate: MatchmakingCandidate): void;
    empty(): boolean;
    get(username: string): MatchmakingCandidate;
    has(username: string): boolean;
    remove(username: string): void;
}

Hierarchy

Iterable<MatchmakingCandidate>
- MatchmakingQueue

Index

Accessors

Methods

add empty get has remove

Accessors

size

get size(): number
Get the number of candidates in the queue.

Returns number
- The number of candidates in the queue.
- Defined in src/models/MatchmakingQueue.ts:41

Methods

add

add(candidate: MatchmakingCandidate): void
Add a candidate to the queue.
Parameters
- candidate: MatchmakingCandidate
  The candidate to add to the queue.
Returns void
- Defined in src/models/MatchmakingQueue.ts:15

empty

empty(): boolean
Check if the queue is empty.

Returns boolean
- True if the queue is empty, false otherwise.
- Defined in src/models/MatchmakingQueue.ts:8

get

get(username: string): MatchmakingCandidate
Get a candidate from the queue by player username.
Parameters
- username: string
  The username of the player to get.
Returns MatchmakingCandidate
- The candidate if player is in queue, undefined otherwise.
- Defined in src/models/MatchmakingQueue.ts:22

has

has(username: string): boolean
Check if a player is in the queue.
Parameters
- username: string
  The username of the player to check.
Returns boolean
- True if the player is in the queue, false otherwise.
- Defined in src/models/MatchmakingQueue.ts:29

remove

remove(username: string): void
Removes a candidate from the queue.
Parameters
- username: string
  The username of the player to remove.
Returns void
- Defined in src/models/MatchmakingQueue.ts:35