@spec connect_user(Teiserver.user_id()) :: Teiserver.Connections.Client.t()

Given a user_id, log them in. If the user already exists as a client then the existing client is returned.

The calling process will be listed as a connection for the client the client will monitor it for the purposes of tracking if the given client is still connected.

@spec get_client(Teiserver.user_id()) :: Teiserver.Connections.Client.t() | nil

Gets a single client from a user_id.

Returns nil if the Client does not exist.

Examples

iex> get_client(123)
%Client{}

iex> get_client(456)
nilcopy

@spec get_client_list([Teiserver.user_id()]) :: [
  Teiserver.Connections.Client.t() | nil
]

Given a list of ids, return a list of client states.

Returns nil if the Client does not exist.

Examples

iex> get_client_list([123, 124])
[%Client{}, %Client{}]

iex> get_client_list([456])
[nil]copy

@spec list_client_ids() :: [Teiserver.user_id()]

Returns the list of client ids.

Examples

iex> list_client_ids()
[123, ...]copy

@spec subscribe_to_client(
  Teiserver.Account.User.id()
  | Teiserver.Account.User.t()
  | Teiserver.Connections.Client.t()
) :: :ok

Subscribes the process to client updates for this user

@spec unsubscribe_from_client(
  Teiserver.Account.User.id()
  | Teiserver.Account.User.t()
  | Teiserver.Connections.Client.t()
) :: :ok

Unsubscribes the process to client updates for this user

@spec update_client(Teiserver.user_id(), map(), String.t()) :: :ok | nil

Updates a client with the new data (excluding lobby related details). If changes are made then it will also generate a Teiserver.Connections.Client:{user_id} pubsub message.

Returns nil if the Client does not exist, :ok if the client does.

Examples

iex> update_client(123, %{afk?: false})
:ok

iex> update_client(456, %{afk?: false})
nilcopy

@spec update_client_full(Teiserver.user_id(), map(), String.t()) :: :ok | nil

Updates a client with the new data for any and all keys (so be careful not to break things like lobby memberships).

Returns nil if the Client does not exist, :ok if the client does.

Examples

iex> update_client_full(123, %{player_number: 123})
:ok

iex> update_client_full(456, %{player_number: 123})
nilcopy

@spec update_client_in_lobby(Teiserver.user_id(), map(), String.t()) :: :ok | nil

Updates a client with the new data for their lobby presence. If changes are made then it will also generate a Teiserver.Connections.Client:{user_id} pubsub message and a Teiserver.Game.Lobby:{lobby_id} pubsub message.

Returns nil if the Client does not exist, :ok if the client does.

Examples

iex> update_client_in_lobby(123, %{player_number: 123})
:ok

iex> update_client_in_lobby(456, %{player_number: 123})
nilcopy