Kaguya v0.6.5 Kaguya.Channel

Channel GenServer, with a few utility functions for working with channels. As a GenServer, it can be called in the following ways:

  • {:send, message}, where message is the message to be sent to the channel
  • {:set_user, nick_string}, where the nick string is a nick with the mode prefix(+, @, etc.)
  • {:get_user, nick}, where nick is the nick of the user to be returned. The Kaguya.Channel.User struct is returned
  • {:del_user, nick}, where nick is the nick of the user to be deleted

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Convenience function to remove a nick from a channel

Convenience function to perform a function on a channel’s buffer and get the result

Convenience function to get information of a user in a channel

Convenience function to get a user count from a channel

Convenience function to get all users from a channel

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Convnenience function to join the specified channel

Convnenience function to part the specified channel

Convenience function to send a nickstring to a channel

Starts a channel worker with the given name and options

Link to this section Functions

Link to this function child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function del_user(chan, nick)

Convenience function to remove a nick from a channel.

Link to this function get_buffer(chan, fun)

Convenience function to perform a function on a channel’s buffer and get the result.

Link to this function get_user(chan, nick)

Convenience function to get information of a user in a channel.

Link to this function get_user_count(chan)

Convenience function to get a user count from a channel.

Link to this function get_users(chan)

Convenience function to get all users from a channel.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

  • The GenServer is disabled by configuration but might be enabled later.
  • An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

Convnenience function to join the specified channel.

Convnenience function to part the specified channel.

Link to this function set_user(chan, nick)

Convenience function to send a nickstring to a channel.

Link to this function start_link(name, opts \\ [])

Starts a channel worker with the given name and options