Hanabi

v0.1.1

Hanabi v0.1.1 Hanabi.Channel View Source

Entry point to interact with channels.

Channels are represented using the following structure :

%Hanabi.Channel{
  name: nil,
  relay_to: [:irc, :virtual],
  topic: "",
  users: [],
  data: nil # allows you to store custom values
}

Hanabi maintains a registry storing all existing channels using their names (e.g. : #hanabi) as keys. This registry can be accessed using the get/1, get_all/0, update/2, set/2 and drop/1 methods.

Link to this section Summary

Functions

add_user(user, channel)

Add an user to a channel

broadcast(channel, msg)

Send the message msg to every user in the channel channel

destroy(channel)

Remove a channel from the registry given its identifier

get(key)

Returns the channel structure registered under the identifier key

get_all()

Returns a list containing all the pairs {key, channel_struct}

get_all_keys()

Returns a list containing all the registered keys (= channel names)

remove_user(user, channel, part_msg \\ nil)

Remove an user from a channel

send_privmsg(sender, channel, content)

Convenience function to send a PRIVMSG to a channel

set(key, channel)

Save the channel struct in the registry under the given identifier. Any existing value will be overwritten

set_topic(channel, topic, name \\ "irc.localhost")

Set the topic of a channel

update(channel, change)

Update the values of an existing user struct stored in the registry

Link to this section Functions

Link to this function add_user(user, channel) View Source

Add an user to a channel.

  • user is either the user’s struct or identifier
  • channel is either the channel’s struct or identifier. A new channel will be created if there is no channel registered under the given identifier.

Return values :

  • {:ok, updated_channel}
  • {:err, :no_such_user}
Link to this function broadcast(channel, msg) View Source

Send the message msg to every user in the channel channel.

  • channel is a channel’s struct or identifier
  • msg is a message’s struct
Link to this function destroy(channel) View Source

Remove a channel from the registry given its identifier.

Link to this function get(key) View Source

Returns the channel structure registered under the identifier key.

If no such identifier is found in the registry, returns nil.

Link to this function get_all() View Source

Returns a list containing all the pairs {key, channel_struct}.

Link to this function get_all_keys() View Source

Returns a list containing all the registered keys (= channel names).

Link to this function remove_user(user, channel, part_msg \\ nil) View Source

Remove an user from a channel.

  • user is either the user’s struct or identifier
  • channel is either the channel’s struct or identifier
  • part_msg is a string if specified

Return values :

  • {:ok, updated_channel}
  • {:err, @err_notonchannel}
  • {:err, @err_nosuchchannel}
  • {:err, :no_such_user}

@err_notonchannel and @err_nosuchchannel are defined in Hanabi.IRC.Numeric.

Link to this function send_privmsg(sender, channel, content) View Source

Convenience function to send a PRIVMSG to a channel.

Link to this function set(key, channel) View Source

Save the channel struct in the registry under the given identifier. Any existing value will be overwritten.

Link to this function set_topic(channel, topic, name \\ "irc.localhost") View Source

Set the topic of a channel.

  • channel is either a channel’s struct or identifier
  • topic is a string
  • name is the one who changed the topic. Defaults to the server’s hostname

Return values :

  • :ok
  • :err if there is no such channel under the given key
Link to this function update(channel, change) View Source

Update the values of an existing user struct stored in the registry.

  • channel is either the channel’s identifier or struct.
  • value is a struct changeset, (topic: "my topic", %{topic: "my topic", users: [], ...})

Returns the updated struct or nil.