ClusterHelper.RoleStore behaviour (ClusterHelper v1.2.0)

Port (behaviour) for role data storage.

Implementations provide persistent storage for role↔node mappings and node membership tracking per scope.

The default implementation is ClusterHelper.ETSStore.

Summary

Types

node_name()

role()

scope()

Callbacks

all_nodes(scope)

Returns all nodes that have at least one role in the scope.

delete_node(node_name, scope)

Removes all role entries for a node in a scope.

delete_role(node_name, scope, role)

Removes a single role from a node in a scope.

delete_roles(node_name, scope, list)

Removes multiple roles from a node in one scope.

get_my_roles(scope)

Returns all roles for the local node in the given scope.

get_nodes(role, scope)

Returns all nodes that have the given role in the scope.

get_roles(node_name, scope)

Returns all roles for the given node in the scope.

init()

Initialises the store (creates tables, etc.).

insert_roles(node_name, scope, list)

Inserts roles for a node in a scope.

Types

node_name()

@type node_name() :: node()

role()

@type role() :: term()

scope()

@type scope() :: atom()

Callbacks

all_nodes(scope)

@callback all_nodes(scope()) :: [node_name()]

Returns all nodes that have at least one role in the scope.

delete_node(node_name, scope)

@callback delete_node(node_name(), scope()) :: :ok

Removes all role entries for a node in a scope.

delete_role(node_name, scope, role)

@callback delete_role(node_name(), scope(), role()) :: :ok

Removes a single role from a node in a scope.

delete_roles(node_name, scope, list)

(optional)

@callback delete_roles(node_name(), scope(), [role()]) :: :ok

Removes multiple roles from a node in one scope.

Optional — implementations may batch the removal for efficiency. When not exported, ClusterHelper.NodeConfig falls back to calling delete_role/3 once per role.

get_my_roles(scope)

@callback get_my_roles(scope()) :: [role()]

Returns all roles for the local node in the given scope.

get_nodes(role, scope)

@callback get_nodes(role(), scope()) :: [node_name()]

Returns all nodes that have the given role in the scope.

get_roles(node_name, scope)

@callback get_roles(node_name(), scope()) :: [role()]

Returns all roles for the given node in the scope.

init()

@callback init() :: :ok

Initialises the store (creates tables, etc.).

insert_roles(node_name, scope, list)

@callback insert_roles(node_name(), scope(), [role()]) :: :ok

Inserts roles for a node in a scope.