gossip v1.4.0 Gossip View Source
Gossip client
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.
Subscribe to a new channel
Unsubscribe to a channel
Get the local list of remote players.
Link to this section Types
Link to this section Functions
broadcast(channel, message)
View Sourcebroadcast(channel_name(), Message.send()) :: :ok
Send a message to the Gossip network
fetch_game(game_name)
View Sourcefetch_game(Gossip.game_name()) :: {:ok, game()} | {:error, :offline}
Get more information about a single game
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.game_update/1.
Note that you will periodically recieve this callback as the Gossip client will refresh it's own state.
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.player_update/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.
The remote gossip version this was built for
Send a player sign in event
player_sign_out(player_name)
View Sourceplayer_sign_out(player_name()) :: :ok
Send a player sign out event
send_tell(sending_player, game_name, player_name, message)
View Sourcesend_tell(player_name(), game_name(), player_name(), message()) :: :ok | {:error, :offline} | {:error, String.t()}
Send a tell to a remote game and player.
Subscribe to a new channel
Unsubscribe to a channel
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.