gossip

v0.4.1

gossip v0.4.1 Gossip View Source

Gossip client

https://github.com/oestrich/gossip

Link to this section Summary

Types

channel()

Functions

broadcast(channel, message)

Send a message to the Gossip network

player_sign_in(player_name)

Send a player sign in event

player_sign_out(player_name)

Send a player sign out event

request_players_online()

Check Gossip for players that are online

send_tell(sending_player, game_name, player_name, message)

Send a tell to a remote game and player

start(type, args)

Called when an application is started

Link to this section Types

Link to this section Functions

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

Send a message to the Gossip network

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

Send a player sign in event

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

Send a player sign out event

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

Check Gossip for players that are online.

The callback you will receive is Gossip.Client.players_status/2.

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

Send a tell to a remote game and player.

Link to this function start(type, args) View Source

Called when an application is started.

This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

  • :normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key :start_phases is :undefined.
  • {:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
  • {:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.