KantanCluster (kantan_cluster v0.2.3) View Source

Form a simple Erlang cluster easily in Elixir.

Link to this section Summary

Types

A node type. See Node.start/3.

option()

Options for a cluster.

Functions

connect(connect_to)

Connects current node to specified nodes.

disconnect(node_name)

Disconnects current node from speficied nodes.

start(opts \\ [])

Starts a node and attempts to connect it to specified nodes. Configuration options can be specified as an argument

stop()

Stops a node and all the connections.

Link to this section Types

node_type()

Specs

node_type() :: :longnames | :shortnames

A node type. See Node.start/3.

option()

Specs

option() ::
  {:node, binary() | atom() | {node_type(), node()}}
  | {:cookie, atom()}
  | {:connect_to, node() | [node()]}

Options for a cluster.

:node
- the name of a node that you want to start
- default: {:longnames, :"xxxx@yyyy.local"} where xxxx is a random string, yyyy is the hostname of a machine
:cookie
- Erlang magic cookie to form a cluster
- default: random cookie
:connect_to
- a list of nodes we want our node to be connected with
- default: []

Link to this section Functions

connect(connect_to)

Specs

connect(node()) :: pid() | nil

connect([node()]) :: [pid() | nil]

Connects current node to specified nodes.

disconnect(node_name)

Specs

disconnect(node()) :: :ok

disconnect([node()]) :: :ok

Disconnects current node from speficied nodes.

start(opts \\ [])

Specs

start([option()]) :: :ok

Starts a node and attempts to connect it to specified nodes. Configuration options can be specified as an argument

KantanCluster.start(
  node: "node1",
  cookie: :hello,
  connect_to: [:"nerves@nerves-mn00.local"]
)

or in your config/config.exs.

config :kantan_cluster,
  node: "node1",
  cookie: :hello,
  connect_to: [:"nerves@nerves-mn00.local"]

stop()

Specs

stop() :: :ok | {:error, :not_allowed | :not_found}

Stops a node and all the connections.