Class ClientManager

A class which maps client ids to their corresponding sockets (if any).

gets, sends, and assigns client information

Hierarchy

ClientManager

Index

Constructors

Properties

clientId? hostId? socketManager spectatorIds

Methods

assignPlayer getClientSocket getClientType getHostSocket getIds sendToClient sendToHost sendToSpectators

Constructors

constructor

new ClientManager(socketManager: SocketManager, hostId?: string, clientId?: string, spectatorIds?: Set<string>): ClientManager
Parameters
- socketManager: SocketManager
- Optional hostId: string
- Optional clientId: string
- spectatorIds: Set<string> = ...
Returns ClientManager
- Defined in src/server/api/client-manager.ts:12

Properties

`Private` `Optional` clientId

clientId?: string

`Private` `Optional` hostId

hostId?: string

`Private` socketManager

socketManager: SocketManager

`Private` spectatorIds

spectatorIds: Set<string> = ...

Methods

assignPlayer

assignPlayer(id: string): void
assigns the passed id to either host/client
Parameters
- id: string
  
  the cookie id of the request
Returns void
- Defined in src/server/api/client-manager.ts:100

getClientSocket

getClientSocket(): undefined | WebSocket
get the client socket

Returns
the socket of the client

Returns undefined | WebSocket
- Defined in src/server/api/client-manager.ts:76

getClientType

getClientType(id: string): ClientType
Returns
the client type
Parameters
- id: string
  
  the cookie id of the request
Returns ClientType
- Defined in src/server/api/client-manager.ts:87

getHostSocket

getHostSocket(): undefined | WebSocket
get the host's socket

Returns
the host socket

Returns undefined | WebSocket
- Defined in src/server/api/client-manager.ts:23

getIds

getIds(): undefined | string[]
gets the ids of all currently connected clients

Returns
- list of ids, if available
Returns undefined | string[]
- Defined in src/server/api/client-manager.ts:114

sendToClient

sendToClient(message: Message): boolean
finds the client and sends a message

Returns
if the socket was found
Parameters
- message: Message
  
  the message to be sent
Returns boolean
- Defined in src/server/api/client-manager.ts:48

sendToHost

sendToHost(message: Message): boolean
finds the host and sends a message

Returns
if the socket was found
Parameters
- message: Message
  
  the message to be sent
Returns boolean
- Defined in src/server/api/client-manager.ts:35

sendToSpectators

sendToSpectators(message: Message): boolean
send an update message to all spectators

Returns
if it completed successfully
Parameters
- message: Message
  
  the message to send
Returns boolean
- Defined in src/server/api/client-manager.ts:61

Generated using TypeDoc