Sovite.Cluster.Peer (sovite v0.6.0)

Copy Markdown View Source

Where a cluster node accepts peers: its name, address, and port, written name@host:port.

{:ok, peer} = Sovite.Cluster.Peer.parse("mx2@10.0.0.2:4370")
{:ok, peer} = Sovite.Cluster.Peer.parse("mx2@[2001:db8::2]:4370")
{:ok, peer} = Sovite.Cluster.Peer.parse("mx2@10.0.0.2", 4370)

The node name is name@host. A host that is not an IP address is resolved when parsing. Parsing creates the node name atom, so only parse names from trusted sources, such as a config file.

Summary

Types

t()

Functions

format(peer)

Formats a peer as name@host:port.

node_name(text)

Parses a node name, name@host, without resolving it.

parse(text, default_port \\ nil)

Parses name@host:port, or name@host with default_port. IPv6 addresses are in brackets.

Types

t()

@type t() :: %Sovite.Cluster.Peer{
  ip: :inet.ip_address(),
  name: node(),
  port: :inet.port_number()
}

Functions

format(peer)

@spec format(t()) :: String.t()

Formats a peer as name@host:port.

node_name(text)

@spec node_name(String.t()) :: {:ok, node()} | {:error, String.t()}

Parses a node name, name@host, without resolving it.

parse(text, default_port \\ nil)

@spec parse(String.t(), :inet.port_number() | nil) ::
  {:ok, t()} | {:error, String.t()}

Parses name@host:port, or name@host with default_port. IPv6 addresses are in brackets.