View Source Cloister.Monitor (cloister v0.17.3)

The actual process that performs the monitoring of the cluster and invokes callbacks.

This process is started and supervised by Cloister.Manager.

Summary

Types

monitor()

Monitor state

node_type()

Type of the node as it has been started

t()

The monitor internal state

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

nodes!(timeout \\ 1000) deprecated

Rehashes the ring and returns the current state

siblings(name \\ __MODULE__)

Returns the nodes in the cluster that are connected to this one in the same group

start_link(opts \\ [])

Used to start Cloister.Monitor.

state(name \\ __MODULE__, timeout \\ 5000, retries \\ 5)

Returns an internal state of the Node

Types

monitor()

@type monitor() :: %{fsm: Finitomata.fsm_name(), ring: atom(), groups: [node()]}

Monitor state

node_type()

@type node_type() :: :longnames | :shortnames | :nonode

Type of the node as it has been started

t()

@type t() :: %Cloister.Monitor{
  otp_app: atom(),
  consensus: pos_integer(),
  listener: module(),
  monitor: module(),
  started_at: DateTime.t(),
  alive?: boolean(),
  clustered?: boolean(),
  sentry?: boolean(),
  ring: atom()
}

The monitor internal state

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

nodes!(timeout \\ 1000)

This function is deprecated. Use `siblings/0` instead.

Rehashes the ring and returns the current state

siblings(name \\ MODULE)

@spec siblings(module()) :: [node()] | {:error, :no_such_ring}

Returns the nodes in the cluster that are connected to this one in the same group

start_link(opts \\ [])

@spec start_link(opts :: keyword()) :: GenServer.on_start()

Used to start Cloister.Monitor.

Internally called by Cloister.Manager.start_link/1. In most cases you don’t need to start Monitor process explicitly.

state(name \\ MODULE, timeout \\ 5000, retries \\ 5)

@spec state(module(), timeout(), non_neg_integer()) :: monitor()

Returns an internal state of the Node