partisan
partisan
v5.0.0-rc.8

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

This modules implements a server that realises the partisan_plumtree_broadcast_handler behaviour in order to diseminate heartbeat messages. Partisan uses these heartbeat messages to stimulate the Epidemic Broadcast Tree construction.

The server will schedule the sending of a hearbeat` message periodically using the `broadcast_heartbeat_interval` option. Notice that this handler does not perform AAE Exchanges, as we will always have a periodic heartbeat. For that reason, the implementation of the <a docgen-rel="seemfa" docgen-href="partisan_plumtree_broadcast_handler#exchange/1" href="partisan_plumtree_broadcast_handler.html#exchange-1"><code>partisan_plumtree_broadcast_handler:exchange/1</code></a> callback always returns `ignore.

Summary

Types

broadcast_id/0
broadcast_message/0
broadcast_payload/0
state/0
timestamp/0

Functions

broadcast_channel()
Returns the channel to be used when broadcasting a message on behalf of this handler.
broadcast_data(Broadcast)
Returns from the broadcast message the identifier and the payload. In this case a tuple where both arguments have the broadcast message timestamp. These messages are used by Partisan as a stimulus for the Epidemic Broadcast Tree (Plumtree) construction.
code_change(OldVsn, State, Extra)
exchange(Peer)
Returns ignore`. This is because we dont need to worry about reliable delivery: we always know we'll have another heartbeat message to further repair during the next interval.
extract_log_type_and_payload(Message)
graft(Timestamp)
Given a message identifier and a clock, return a given message.
handle_call(Event, From, State)
handle_cast(Event, State)
handle_info(Event, State)
init(_)
is_stale(Timestamp)
Use the clock on the object to determine if this message is stale or not.
merge(Timestamp, _)
Perform a merge of an incoming object with an object in the local datastore.
start_link()
Same as start_link([]).
start_link(Opts)
Start and link to calling process.
terminate(Reason, State)

Types

Link to this type

broadcast_id/0

View Source 
-type broadcast_id() :: timestamp().
Link to this type

broadcast_message/0

View Source 
-type broadcast_message() :: #broadcast{}.
Link to this type

broadcast_payload/0

View Source 
-type broadcast_payload() :: timestamp().
Link to this type

state/0

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

timestamp/0

View Source 
-type timestamp() :: {node(), non_neg_integer()}.

Functions

Link to this function

broadcast_channel()

View Source 
-spec broadcast_channel() -> partisan:channel().
Returns the channel to be used when broadcasting a message on behalf of this handler.
Link to this function

broadcast_data(Broadcast)

View Source 
-spec broadcast_data(broadcast_message()) -> {broadcast_id(), broadcast_payload()}.
Returns from the broadcast message the identifier and the payload. In this case a tuple where both arguments have the broadcast message timestamp. These messages are used by Partisan as a stimulus for the Epidemic Broadcast Tree (Plumtree) construction.
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

exchange(Peer)

View Source 
-spec exchange(node()) -> {ok, pid()} | {error, any()} | ignore.
Returns ignore`. This is because we dont need to worry about reliable delivery: we always know we'll have another heartbeat message to further repair during the next interval.
Link to this function

extract_log_type_and_payload(Message)

View Source
Link to this function

graft(Timestamp)

View Source 
-spec graft(broadcast_id()) -> stale | {ok, broadcast_payload()} | {error, term()}.
Given a message identifier and a clock, return a given message.
Link to this function

handle_call(Event, From, State)

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

handle_cast(Event, State)

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

handle_info(Event, State)

View Source
Link to this function

init(_)

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

is_stale(Timestamp)

View Source 
-spec is_stale(broadcast_id()) -> boolean().
Use the clock on the object to determine if this message is stale or not.
Link to this function

merge(Timestamp, _)

View Source 
-spec merge(broadcast_id(), broadcast_payload()) -> boolean().
Perform a merge of an incoming object with an object in the local datastore.
Link to this function

start_link()

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

start_link(Opts)

View Source 
-spec start_link(list()) -> {ok, pid()} | ignore | {error, term()}.
Start and link to calling process.
Link to this function

terminate(Reason, State)

View Source 
-spec terminate(term(), state()) -> term().