-spec add_members(Members :: [partisan:node_spec()]) -> ok | {error, not_implemented}.

Joins every node specification in Members that is not yet a member, leaving the manager to decide how (the pluggable manager joins it, the HyParView one treats the list as an exchange). Never removes a member: a member absent from Members is unaffected. A member only ever leaves the cluster through leave/0 or leave/1.

Pinned by partisan_peer_discovery_agent_test and partisan_SUITE:discovery_never_evicts_test/1.

-spec add_sup_callback(fun(([partisan:node_spec()]) -> any())) -> ok.

Adds a supervised callback to receive peer service membership updates.

Deprecated: prefer partisan_membership:subscribe/0 — receive {partisan_membership, Members} in your own process — or poll partisan_membership:members/0. This is a compatibility shim over the membership snapshot's push feed: it spawns a relay process, linked to the caller, that invokes Function with the current member specs on each change. The callback therefore runs asynchronously, in its own process: it does not block the membership path, and one that crashes does not affect others.

-spec broadcast_members() -> ordsets:ordset(node()).

Returns the broadcast servers view of full cluster membership. Wait indefinitely for a response is returned from the process.

-spec broadcast_members(infinity | pos_integer()) -> ordsets:ordset(node()).

Returns the broadcast servers view of full cluster membership. Waits Timeout ms for a response from the server.

-spec cancel_exchanges(partisan_plumtree_broadcast:selector()) ->
                          partisan_plumtree_broadcast:exchanges().

cancel exchanges started by this node.

Return peer service connections

-spec decode(term()) -> term().

Decode peer_service_manager state from an encoded form

-spec exchanges() -> partisan_plumtree_broadcast:exchanges() | no_return().

return a list of exchanges, started by broadcast on thisnode, that are running.

-spec exchanges(node()) -> partisan_plumtree_broadcast:exchanges() | no_return().

returns a list of exchanges, started by broadcast on Node, that are running.

-spec inject_partition(partisan:node_spec(), ttl()) -> {ok, reference()} | {error, not_implemented}.

Inject a partition.

-spec leave() -> ok.

Leave the cluster.

-spec leave(partisan:node_spec()) -> ok.

Remove a node from the cluster.

-spec manager() -> module().

Return current peer service manager for this

-spec member(Node :: node() | partisan:node_spec()) -> boolean().

Return a sampling of nodes connected to this node. When using a full-mesh topology i.e. partisan_pluggable_peer_service_manager or partisan_static_peer_service_manager this is the set of all cluster members. However, if you're using other managers, the result will only be a sampling of the nodes.

-spec members() -> {ok, [node()]}.

Return cluster members

-spec members_for_orchestration() -> {ok, [partisan:node_spec()]}.

Return cluster members

-spec on_down(node() | partisan:node_spec() | any | '_', function()) -> ok | {error, not_implemented}.

Trigger function on connection close for a given node. Function is a function object taking zero or a single argument, where the argument is the Node name.

At the moment, this only works when using a full-mesh topology i.e. partisan_pluggable_peer_service_manager or partisan_static_peer_service_manager.

-spec on_down(node() | partisan:node_spec() | any | '_',
              partisan_peer_service_manager:on_event_fun(),
              Opts :: #{channel => partisan:channel()}) ->
                 ok | {error, not_implemented}.

Trigger function on connection close for a given node. Function is a function object taking zero or a single argument, where the argument is the Node name.

At the moment, this only works when using a full-mesh topology i.e. partisan_pluggable_peer_service_manager or partisan_static_peer_service_manager.

-spec on_up(node() | partisan:node_spec() | any | '_', partisan_peer_service_manager:on_event_fun()) ->
               ok | {error, not_implemented}.

Trigger function on connection open for a given node. Function is a function object taking zero or a single argument, where the argument is the Node name.

At the moment, this only works when using a full-mesh topology i.e. partisan_pluggable_peer_service_manager or partisan_static_peer_service_manager.

-spec on_up(node() | partisan:node_spec() | any | '_',
            partisan_peer_service_manager:on_event_fun(),
            Opts :: #{channel => partisan:channel()}) ->
               ok | {error, not_implemented}.

Trigger function on connection open for a given node. Function is a function object taking zero or a single argument, where the argument is the Node name.

At the moment, this only works when using a full-mesh topology i.e. partisan_pluggable_peer_service_manager or partisan_static_peer_service_manager.

-spec reserve(atom()) -> ok | {error, no_available_slots}.

Reserve a slot for the particular tag.

-spec resolve_partition(reference()) -> ok | {error, not_implemented}.

Resolve a partition.

Stop

Stop

-spec update_members(Members :: [partisan:node_spec()]) -> ok | {error, not_implemented}.

Replaces the cluster membership with Members: a node specification in the list that is not yet a member is joined, and a member absent from the list leaves the cluster — the removal is gossiped, and the removed node shuts its peer service manager down once the gossip reaches it.

This is for an external membership authority. A discovery backend must use add_members/1: its answer omits members that are booting or briefly unhealthy, and passing it here evicts them.