gossip v1.0.0 Gossip View Source

Gossip client

https://github.com/oestrich/gossip

Link to this section Summary

Functions

Send a message to the Gossip network

Get more information about a single game

Get more detail about connected games

Check Gossip for players that are online

Check Gossip for players of a single game

Get the local list of remote games

The remote gossip version this was built for

Send a player sign in event

Send a player sign out event

Send a tell to a remote game and player

Get the local list of remote players

Link to this section Types

Link to this type channel_name() View Source
channel_name() :: String.t()
Link to this type game_name() View Source
game_name() :: String.t()
Link to this type player_name() View Source
player_name() :: String.t()
Link to this type user_agent() View Source
user_agent() :: String.t()

Link to this section Functions

Link to this function broadcast(channel, message) View Source
broadcast(channel_name(), Message.send()) :: :ok

Send a message to the Gossip network

Link to this function fetch_game(game_name) View Source
fetch_game(Gossip.game_name()) :: {:ok, game()} | {:error, :offline}

Get more information about a single game

Link to this function fetch_games() View Source
fetch_games() :: :ok

Get more detail about connected games.

This sends a games/status event to Gossip, sending back an event per connected game to gossip. You will receive the updates via the callback Gossip.Client.games_status/1.

Note that you will periodically recieve this callback as the Gossip client will refresh it’s own state.

Link to this function fetch_players() View Source
fetch_players() :: :ok

Check Gossip for players that are online.

This sends a players/status event to Gossip, sending back the current game presence on the server. You will receive the updates via the callback Gossip.Client.players_status/2.

Note that you will periodically recieve this callback as the Gossip client will refresh it’s own state.

Check Gossip for players of a single game

Unlike the full list version, this will block until Gossip returns.

Get the local list of remote games.

It is periodically updated by retrieving the full list.

Link to this function gossip_version() View Source
gossip_version() :: String.t()

The remote gossip version this was built for

Link to this function player_sign_in(player_name) View Source
player_sign_in(player_name()) :: :ok

Send a player sign in event

Link to this function player_sign_out(player_name) View Source
player_sign_out(player_name()) :: :ok

Send a player sign out event

Link to this function send_tell(sending_player, game_name, player_name, message) View Source
send_tell(player_name(), game_name(), player_name(), message()) ::
  :ok | {:error, :offline} | {:error, String.t()}

Send a tell to a remote game and player.

Get the local list of remote players.

This is tracked as players sign in and out. It is also periodically updated by retrieving the full list.