kalevala v0.1.0 Kalevala.Character.Foreman.Callbacks behaviour View Source

Callbacks for a integrating with the character foreman process

Link to this section Summary

Types

opts()

Options for starting the foreman process

state()

Callbacks

init(state, opts)

Fill in state with any passed in options

send_options(state, list)

Send options to a connection process

send_output(state, list)

Send text to a connection process

terminate(state)

Called when the foreman process is halted through a conn

terminating(state)

The process is terminating from a :terminate message

track_presence(state, arg2)

The character updated and presence should be tracked

Link to this section Types

opts()

opts() :: Keyword.t()

Options for starting the foreman process

state()

state() :: Kalevala.Character.Foreman.t()

Link to this section Callbacks

init(state, opts)

init(state(), opts()) :: state()

Fill in state with any passed in options

send_options(state, list)

send_options(state(), list()) :: :ok

Send options to a connection process

send_output(state, list)

send_output(state(), list()) :: :ok

Send text to a connection process

terminate(state)

terminate(state()) :: :ok

Called when the foreman process is halted through a conn

Perform whatever actions are required to start terminating.

terminating(state)

terminating(state()) :: :ok

The process is terminating from a :terminate message

Perform whatever is required before terminating.

track_presence(state, arg2)

track_presence(state(), Kalevala.Character.Conn.t()) :: :ok

The character updated and presence should be tracked