View Source ProcessHub.Service.Cluster (ProcessHub v0.3.2-alpha)

ProcessHub instances with the same hub_id will automatically form a cluster. The cluster service provides API functions for managing the cluster.

Summary

Functions

add_hub_node(hub_id, node)

Adds a new node to the hub cluster and returns new list of nodes.

new_node?(nodes, node)

Returns a boolean indicating whether the node exists in the cluster.

nodes(hub_id, opts \\ [])

Returns a list of nodes in the cluster.

promote_to_node(hub_id, node_name)

Promotes the current node to a cluster node.

propagate_self(hub_id, node)

Sends a cluster join event to the remote node.

rem_hub_node(hub_id, node)

Removes a node from the cluster and returns new list of nodes.

Functions

Link to this function

add_hub_node(hub_id, node)

View Source 
@spec add_hub_node(atom(), node()) :: [node()]

Adds a new node to the hub cluster and returns new list of nodes.

Link to this function

new_node?(nodes, node)

View Source 
@spec new_node?([node()], node()) :: boolean()

Returns a boolean indicating whether the node exists in the cluster.

Link to this function

nodes(hub_id, opts \\ [])

View Source 
@spec nodes(ProcessHub.hub_id(), [:include_local] | nil) :: [node()]

Returns a list of nodes in the cluster.

Link to this function

promote_to_node(hub_id, node_name)

View Source 
@spec promote_to_node(ProcessHub.hub_id(), node()) :: :ok | {:error, :not_alive}

Promotes the current node to a cluster node.

Link to this function

propagate_self(hub_id, node)

View Source 
@spec propagate_self(ProcessHub.hub_id(), node()) :: term()

Sends a cluster join event to the remote node.

Link to this function

rem_hub_node(hub_id, node)

View Source 
@spec rem_hub_node(atom(), node()) :: [node()]

Removes a node from the cluster and returns new list of nodes.