1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
defmodule ExIrc do
@moduledoc """
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
"""
use Supervisor
##############
# Public API
##############
@doc """
Start the ExIrc supervisor.
"""
@spec start! :: {:ok, pid} | {:error, term}
def start! do
:supervisor.start_link({:local, :exirc}, __MODULE__, [])
end
@doc """
Start a new ExIrc client
"""
@spec start_client! :: {:ok, pid} | {:error, term}
def start_client! do
# Start the client worker
:supervisor.start_child(:exirc, worker(ExIrc.Client, []))
end
##############
# Supervisor API
##############
@spec init(any) :: {:ok, pid} | {:error, term}
def init(_) do
supervise [], strategy: :one_for_one
end
end
|
