partisan
partisan
v5.0.0-rc.8

View Source partisan_pluggable_peer_service_manager (partisan v5.0.0-rc.8)

This module realises the partisan_peer_service_manager behaviour implementing a peer sampling service with a pluggable overlay topology by delegating the topology definition to a callback module implementing the {partisan_peer_service_strategy} behaviour.

Characteristics

  • Uses TCP/IP.
  • All nodes communicate and maintain connections with all other nodes.
  • Nodes periodically send heartbeat messages. The service considers a node "failed" when it misses X heartbeats.
  • Point-to-point messaging with a single network hop.
  • Eventually consistent membership maintained in a CRDT and replicated using gossip.
  • Scalability limited to hundres of nodes (60-200 nodes).

Summary

Types

channel_subs/0
from/0
info/0
interpos_arg/0
interpos_fun/0
interposition_map/1
node_subs/0
on_event_fun/0
t/0
tag/0
x_interpos_fun/0

Functions

add_interposition_fun(Name, InterpositionFun)
add_post_interposition_fun(Name, PostInterpositionFun)
add_pre_interposition_fun(Name, Fun)
cast_message(Term, Message)
cast_message(Node, ServerRef, Message)
Cast a message to a remote gen_server.
cast_message(Node, ServerRef, Message, Options)
Cast a message to a remote gen_server.
code_change(OldVsn, State, Extra)
decode(Membership)
Decode state.
forward_message(Term, Message)
Gensym support for forwarding.
forward_message(PidOrName, Message, Opts)
Gensym support for forwarding.
forward_message(Node, ServerRef, Message, Opts)
Forward message to registered process on the remote side.
get_interposition_funs()
get_local_state()
Return local node's view of cluster membership.
get_pre_interposition_funs()
handle_call(Event, From, State)
handle_cast(Event, State)
handle_info(Msg, State)
init(_)
inject_partition(Origin, TTL)
Inject a partition.
join(NodeSpec)
Attempt to join a remote node.
leave()
Leave the cluster.
leave(NodeSpec)
Remove another node from the cluster.
maybe_reply_sync_joins(State)
member(Node)
Returns true if node Node is a member in the membership list. Otherwise returns false.
members()
Return membership list.
members_for_orchestration()
Return membership list.
on_down(Arg, Fun)
Trigger function on connection close for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
on_down(Node, Fun, Opts)
Trigger function on connection close for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
on_up(Arg, Fun)
Trigger function on connection open for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
on_up(Node, Fun, Opts)
Trigger function on connection open for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
partitions()
Return partitions.
receive_message(Node, Channel, Cmd)
Receive message from a remote manager.
remove_interposition_fun(Name)
remove_post_interposition_fun(Name)
remove_pre_interposition_fun(Name)
reserve(Tag)
Reserve a slot for the particular tag.
resolve_partition(Reference)
Resolve a partition.
send_message(Node, Message)
Send message to a remote peer service manager.
start_link()
Same as start_link([]).
supports_capability(Arg)
sync_join(NodeSpec)
Attempt to join a remote node.
terminate(Reason, State)
update_members(Members)
Update membership.

Types

Link to this type

channel_subs/0

View Source 
-type channel_subs() :: #{{'_' | node(), partisan:channel()} => on_event_fun()}.
Link to this type

from/0

View Source 
-type from() :: {pid(), atom()}.
Link to this type

info/0

View Source 
-type info() ::
    connections | retransmit | periodic | instrumentation | distance | tree_refresh |
    {'EXIT', partisan:any_pid(), any()} |
    {connected, partisan:node_spec(), partisan:channel(), tag(), t()}.
Link to this type

interpos_arg/0

View Source 
-type interpos_arg() :: {receive_message, node(), any()} | {forward_message, node(), any()}.
Link to this type

interpos_fun/0

View Source 
-type interpos_fun() :: fun((interpos_arg()) -> interpos_arg()).
Link to this type

interposition_map/1

View Source 
-type interposition_map(T) :: #{any() => T}.
Link to this type

node_subs/0

View Source 
-type node_subs() :: #{'_' | node() => on_event_fun()}.
Link to this type

on_event_fun/0

View Source 
-type on_event_fun() :: partisan_peer_service_manager:on_event_fun().
Link to this type

t/0

View Source 
-type t() :: #state{}.
Link to this type

tag/0

View Source 
-type tag() :: atom().
Link to this type

x_interpos_fun/0

View Source 
-type x_interpos_fun() :: fun((interpos_arg()) -> ok).

Functions

Link to this function

add_interposition_fun(Name, InterpositionFun)

View Source 
-spec add_interposition_fun(any(), interpos_fun()) -> ok.
Link to this function

add_post_interposition_fun(Name, PostInterpositionFun)

View Source 
-spec add_post_interposition_fun(any(), x_interpos_fun()) -> ok.
Link to this function

add_pre_interposition_fun(Name, Fun)

View Source 
-spec add_pre_interposition_fun(any(), x_interpos_fun()) -> ok.
Link to this function

cast_message(Term, Message)

View Source 
-spec cast_message(Term :: partisan:any_pid() | partisan:any_name(), Message :: partisan:message()) ->
                ok.
Link to this function

cast_message(Node, ServerRef, Message)

View Source
Cast a message to a remote gen_server.
Link to this function

cast_message(Node, ServerRef, Message, Options)

View Source
Cast a message to a remote gen_server.
Link to this function

code_change(OldVsn, State, Extra)

View Source 
-spec code_change(term() | {down, term()}, t(), term()) -> {ok, t()}.
Link to this function

decode(Membership)

View Source
Decode state.
Link to this function

forward_message(Term, Message)

View Source
Gensym support for forwarding.
Link to this function

forward_message(PidOrName, Message, Opts)

View Source
Gensym support for forwarding.
Link to this function

forward_message(Node, ServerRef, Message, Opts)

View Source
Forward message to registered process on the remote side.
Link to this function

get_interposition_funs()

View Source 
-spec get_interposition_funs() -> interposition_map(interpos_fun()).
Link to this function

get_local_state()

View Source
Return local node's view of cluster membership.
Link to this function

get_pre_interposition_funs()

View Source 
-spec get_pre_interposition_funs() -> interposition_map(x_interpos_fun()).
Link to this function

handle_call(Event, From, State)

View Source
Link to this function

handle_cast(Event, State)

View Source 
-spec handle_cast(term(), t()) -> {noreply, t()} | {stop, normal, t()}.
Link to this function

handle_info(Msg, State)

View Source 
-spec handle_info(info(), t()) -> {noreply, t()}.
Link to this function

init(_)

View Source 
-spec init([]) -> {ok, t()}.
Link to this function

inject_partition(Origin, TTL)

View Source
Inject a partition.
Link to this function

join(NodeSpec)

View Source
Attempt to join a remote node.
Link to this function

leave()

View Source
Leave the cluster.
Link to this function

leave(NodeSpec)

View Source
Remove another node from the cluster.
Link to this function

maybe_reply_sync_joins(State)

View Source
Link to this function

member(Node)

View Source
Returns true if node Node is a member in the membership list. Otherwise returns false.
Link to this function

members()

View Source
Return membership list.
Link to this function

members_for_orchestration()

View Source
Return membership list.
Link to this function

on_down(Arg, Fun)

View Source
Trigger function on connection close for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
Link to this function

on_down(Node, Fun, Opts)

View Source
Trigger function on connection close for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
Link to this function

on_up(Arg, Fun)

View Source
Trigger function on connection open for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
Link to this function

on_up(Node, Fun, Opts)

View Source
Trigger function on connection open for a given node. Fun is a function object taking zero or a single argument, where the argument is the Node name.
Link to this function

partitions()

View Source
Return partitions.
Link to this function

receive_message(Node, Channel, Cmd)

View Source
Receive message from a remote manager.
Link to this function

remove_interposition_fun(Name)

View Source 
-spec remove_interposition_fun(any()) -> ok.
Link to this function

remove_post_interposition_fun(Name)

View Source 
-spec remove_post_interposition_fun(any()) -> ok.
Link to this function

remove_pre_interposition_fun(Name)

View Source 
-spec remove_pre_interposition_fun(any()) -> ok.
Link to this function

reserve(Tag)

View Source
Reserve a slot for the particular tag.
Link to this function

resolve_partition(Reference)

View Source
Resolve a partition.
Link to this function

send_message(Node, Message)

View Source
Send message to a remote peer service manager.
Link to this function

start_link()

View Source 
-spec start_link() -> {ok, pid()} | ignore | {error, term()}.
Same as start_link([]).
Link to this function

supports_capability(Arg)

View Source 
-spec supports_capability(Arg :: atom()) -> boolean().
Link to this function

sync_join(NodeSpec)

View Source
Attempt to join a remote node.
Link to this function

terminate(Reason, State)

View Source 
-spec terminate(term(), t()) -> term().
Link to this function

update_members(Members)

View Source
Update membership.