partisan v5.0.0-beta.21

View Source partisan_plumtree_broadcast (partisan v5.0.0-beta.21)

Link to this section Summary

Types

exchange/0
exchanges/0
message_id/0
message_round/0
Lazy messages that have not been acked. Messages are added to this set when a node is sent a lazy message (or when it should be sent one sometime in the future). Messages are removed when the lazy pushes are acknowledged via graft or ignores. Entries are keyed by their destination These are stored in the ?PLUMTREE_OUTSTANDING ets table under using nodename as key. PLUMTREE_OUTSTANDING is created and owned by partisan_sup
nodeset/0
outstanding/0
selector/0
state/0

Functions

broadcast(Broadcast, Mod)

Broadcasts a message originating from this node. The message will be delivered to each node at least once. The Mod passed must be loaded on all members of the cluster and implement the partisan_plumtree_broadcast_handler behaviour which is responsible for handling the message on remote nodes as well as providing some other information both locally and on other nodes.

broadcast_channel(Mod)

Returns the channel to be used when sending broadcasting a message on behalf of module Mod.

broadcast_members()
Returns the broadcast servers view of full cluster membership. Wait indefinitely for a response is returned from the process.
broadcast_members(Timeout)
Returns the broadcast servers view of full cluster membership. Waits Timeout ms for a response from the server.
cancel_exchanges(Selector)
Cancel exchanges started by this node.
code_change(OldVsn, State, Extra)
debug_get_peers(Node, Root)
return the peers for Node for the tree rooted at Root. Wait indefinitely for a response is returned from the process
debug_get_peers(Node, Root, Timeout)
return the peers for Node for the tree rooted at Root. Waits Timeout ms for a response from the server
debug_get_tree(Root, Nodes)
return peers for all Nodes for tree rooted at Root Wait indefinitely for a response is returned from the process
exchanges()
return a list of exchanges, started by broadcast on this node, that are running.
exchanges(Node)
Returns a list of running exchanges, started on Node.
exchanges(Node, Timeout)
Returns a list of running exchanges, started on Node.
get_peers(Root)
handle_call(_, From, State)
handle_cast(_, State)
handle_info(Event, State)
init(_)
start_link()
Starts the broadcast server on this node. The initial membership list is fetched from the peer service. If the node is a singleton then the initial eager and lazy sets are empty. If there are two nodes, each will be in the others eager set and the lazy sets will be empty. When number of members is less than 5, each node will initially have one other node in its eager set and lazy set. If there are more than five nodes each node will have at most two other nodes in its eager set and one in its lazy set, initially. In addition, after the broadcast server is started, a callback is registered with ring_events to generate membership updates as the ring changes.
start_link(InitMembers, InitEagers, InitLazys, Mods, Opts)

Starts the broadcast server on this node. InitMembers must be a list of all members known to this node when starting the broadcast server. InitEagers are the initial peers of this node for all broadcast trees. InitLazys is a list of random peers not in InitEagers that will be used as the initial lazy peer shared by all trees for this node. If the number of nodes in the cluster is less than 3, InitLazys should be an empty list. InitEagers and InitLazys must also be subsets of InitMembers. Mods is a list of modules that may be handlers for broadcasted messages. All modules in Mods should implement the partisan_plumtree_broadcast_handler behaviour.

terminate(Reason, State)
update(LocalState0)
Notifies broadcast server of membership update This is the function is added to partisan_peer_service_events using partisan_peer_service:add_sup_callback(fun ?MODULE:update/1),

Link to this section Types

Link to this type

exchange/0

View Source 
-type exchange() :: {module(), node(), reference(), pid()}.
Link to this type

exchanges/0

View Source 
-type exchanges() :: [exchange()].
Link to this type

message_id/0

View Source 
-type message_id() :: any().
Link to this type

message_round/0

View Source 
-type message_round() :: non_neg_integer().
Lazy messages that have not been acked. Messages are added to this set when a node is sent a lazy message (or when it should be sent one sometime in the future). Messages are removed when the lazy pushes are acknowledged via graft or ignores. Entries are keyed by their destination These are stored in the ?PLUMTREE_OUTSTANDING ets table under using nodename as key. PLUMTREE_OUTSTANDING is created and owned by partisan_sup
Link to this type

nodeset/0

View Source 
-type nodeset() :: ordsets:ordset(node()).
Link to this type

outstanding/0

View Source 
-type outstanding() :: {message_id(), module(), message_round(), node()}.
Link to this type

selector/0

View Source 
-type selector() :: all | {peer, node()} | {mod, module()} | reference() | pid().
Link to this type

state/0

View Source 
-type state() :: #state{}.

Link to this section Functions

Link to this function

broadcast(Broadcast, Mod)

View Source 
-spec broadcast(any(), module()) -> ok.

Broadcasts a message originating from this node. The message will be delivered to each node at least once. The Mod passed must be loaded on all members of the cluster and implement the partisan_plumtree_broadcast_handler behaviour which is responsible for handling the message on remote nodes as well as providing some other information both locally and on other nodes.

The broadcast will be sent over the channel defined by broadcast_channel/1.
Link to this function

broadcast_channel(Mod)

View Source 
-spec broadcast_channel(Mod :: module()) -> partisan:channel().

Returns the channel to be used when sending broadcasting a message on behalf of module Mod.

The channel defined by the callback Mod:broadcast_channel() or default channel i.e. partisan:default_channel/0 if the callback is not implemented.
Link to this function

broadcast_members()

View Source 
-spec broadcast_members() -> nodeset().
Returns the broadcast servers view of full cluster membership. Wait indefinitely for a response is returned from the process.
Link to this function

broadcast_members(Timeout)

View Source 
-spec broadcast_members(infinity | pos_integer()) -> nodeset().
Returns the broadcast servers view of full cluster membership. Waits Timeout ms for a response from the server.
Link to this function

cancel_exchanges(Selector)

View Source 
-spec cancel_exchanges(selector()) -> exchanges().
Cancel exchanges started by this node.
Link to this function

code_change(OldVsn, State, Extra)

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

debug_get_peers(Node, Root)

View Source 
-spec debug_get_peers(node(), node()) -> {nodeset(), nodeset()}.
return the peers for Node for the tree rooted at Root. Wait indefinitely for a response is returned from the process
Link to this function

debug_get_peers(Node, Root, Timeout)

View Source 
-spec debug_get_peers(node(), node(), infinity | pos_integer()) -> {nodeset(), nodeset()}.
return the peers for Node for the tree rooted at Root. Waits Timeout ms for a response from the server
Link to this function

debug_get_tree(Root, Nodes)

View Source 
-spec debug_get_tree(node(), [node()]) -> [{node(), {nodeset(), nodeset()}}].
return peers for all Nodes for tree rooted at Root Wait indefinitely for a response is returned from the process
Link to this function

exchanges()

View Source 
-spec exchanges() -> exchanges().
return a list of exchanges, started by broadcast on this node, that are running.
Link to this function

exchanges(Node)

View Source 
-spec exchanges(node()) -> partisan_plumtree_broadcast:exchanges().
Returns a list of running exchanges, started on Node.
Link to this function

exchanges(Node, Timeout)

View Source 
-spec exchanges(node(), timeout()) -> partisan_plumtree_broadcast:exchanges().
Returns a list of running exchanges, started on Node.
Link to this function

get_peers(Root)

View Source 
-spec get_peers(Root :: node()) -> list().
Link to this function

handle_call(_, From, State)

View Source 
-spec handle_call(term(), {pid(), term()}, state()) -> {reply, term(), state()}.
Link to this function

handle_cast(_, State)

View Source 
-spec handle_cast(term(), state()) -> {noreply, state()}.
Link to this function

handle_info(Event, State)

View Source 
-spec handle_info(exchange_tick | lazy_tick | {'DOWN', _, process, _, _}, state()) -> {noreply, state()}.
Link to this function

init(_)

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

start_link()

View Source 
-spec start_link() -> {ok, pid()} | ignore | {error, term()}.
Starts the broadcast server on this node. The initial membership list is fetched from the peer service. If the node is a singleton then the initial eager and lazy sets are empty. If there are two nodes, each will be in the others eager set and the lazy sets will be empty. When number of members is less than 5, each node will initially have one other node in its eager set and lazy set. If there are more than five nodes each node will have at most two other nodes in its eager set and one in its lazy set, initially. In addition, after the broadcast server is started, a callback is registered with ring_events to generate membership updates as the ring changes.
Link to this function

start_link(InitMembers, InitEagers, InitLazys, Mods, Opts)

View Source 
-spec start_link(InitMembers :: [node()],
           InitEagers :: [node()],
           InitLazys :: [node()],
           Mods :: [module()],
           Opts :: proplists:proplist() | map()) ->
              {ok, pid()} | ignore | {error, term()}.

Starts the broadcast server on this node. InitMembers must be a list of all members known to this node when starting the broadcast server. InitEagers are the initial peers of this node for all broadcast trees. InitLazys is a list of random peers not in InitEagers that will be used as the initial lazy peer shared by all trees for this node. If the number of nodes in the cluster is less than 3, InitLazys should be an empty list. InitEagers and InitLazys must also be subsets of InitMembers. Mods is a list of modules that may be handlers for broadcasted messages. All modules in Mods should implement the partisan_plumtree_broadcast_handler behaviour.

Opts is a proplist or map with the following possible options:
  • lazy_tick_period :: non_neg_integer() - Flush all outstanding lazy pushes period (in milliseconds)
  • exchange_tick_period :: non_neg_integer() - Possibly perform an exchange period (in milliseconds)
NOTE: When starting the server using start_link/2 no automatic membership update from ring_events is registered. Use start_link/0.
Link to this function

terminate(Reason, State)

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

update(LocalState0)

View Source 
-spec update([node()]) -> ok.
Notifies broadcast server of membership update This is the function is added to partisan_peer_service_events using partisan_peer_service:add_sup_callback(fun ?MODULE:update/1),