exirc

exirc v2.0.0 ExIRC

Supervises IRC client processes

Usage:

# Start the supervisor (started automatically when ExIRC is run as an application)
ExIRC.start_link

# Start a new IRC client
{:ok, client} = ExIRC.start_client!

# Connect to an IRC server
ExIRC.Client.connect! client, "localhost", 6667

# Logon
ExIRC.Client.logon client, "password", "nick", "user", "name"

# Join a channel (password is optional)
ExIRC.Client.join client, "#channel", "password"

# Send a message
ExIRC.Client.msg client, :privmsg, "#channel", "Hello world!"

# Quit (message is optional)
ExIRC.Client.quit client, "message"

# Stop and close the client connection
ExIRC.Client.stop! client

Link to this section Summary

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

start!()

Start the ExIRC supervisor.

start_client!()

Start a new ExIRC client under the ExIRC supervisor

start_link!()

Start a new ExIRC client

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

start!()

Specs

start!() :: Supervisor.on_start()

Start the ExIRC supervisor.

Link to this function

start_client!()

Specs

start_client!() :: DynamicSupervisor.on_start_child()

Start a new ExIRC client under the ExIRC supervisor

Link to this function

start_link!()

Specs

start_link!() :: GenServer.on_start()

Start a new ExIRC client