View Source partisan (partisan v5.0.0-beta.21)
Link to this section Summary
Functions
Broadcasts a message originating from this node.
Name. Fails if a channel named Name doesn't exist.Arg is the caller's process identifier.partisan_remote_ref:from_term(erlang:make_ref()).Sends a monitor request of type Type to the entity identified by Item. If the monitored entity does not exist or it changes monitored state, the caller of monitor/2 is notified by a message on the following format: {Tag, MonitorRef, Type, Object, Info}
Sends a monitor request of type Type to the entity identified by Item. If the monitored entity does not exist or it changes monitored state, the caller of monitor/2 is notified by a message on the following format
Monitor the status of the node Node. If Flag is true, monitoring is turned on. If Flag is false, monitoring is turned off.
Returns the node specification of the local node. This is the information required when other nodes wish to join this node (See partisan_peer_service:join/1).
Return the partisan node_spec() for node named Node.
Return the tuple {ok, node_spec() for node named Node or the tuple {error, Reason}.
Returns a list of all nodes connected to this node via Partisan. Equivalent to erlang:nodes/1. Sames as calling nodes(visible).
Returns the partisan encoded pid for the calling process. This is equivalent to calling partisan_remote_ref:from_term(self()).
Returns the partisan encoded pid for the calling process.
send_after(Time, Dest, Msg, []).erlang:send_after/4. It calls the native implementation for local destinations. For remote destinations it spawns a process that uses a timer and accepts cancellation ( via cancel_timer/1,2), so this is less efficient than the native implementation.badarg if Arg is a remote reference for another node.Link to this section Types
-type actor() :: binary().
-type channel() :: atom().
-type channel_opts() ::
#{parallelism := non_neg_integer(), monotonic => boolean(), compression => boolean() | 0..9}.
-type demonitor_opt() :: flush | info.
-type forward_opts() :: partisan_peer_service_manager:forward_opts().
-type listen_addr() :: #{ip := inet:ip_address(), port := non_neg_integer()}.
-type message() :: term().
-type monitor_nodes_opt() :: nodedown_reason | {node_type, visible | hidden | all} | {channel, channel()} | {channel_fallback, boolean()}.
-type monitor_opt() :: erlang:monitor_option() | {channel, partisan:channel()}.
-type monitor_process_id() :: erlang:monitor_process_identifier() | partisan_remote_ref:p() | partisan_remote_ref:n().
-type node_spec() :: #{name := node(), listen_addrs := [listen_addr()], channels := #{channel() => channel_opts()}}.
-type node_type() :: this | known | visible | connected | hidden | all.
-type send_after_dst() :: pid() | (RegName :: atom()) | (Pid :: partisan_remote_ref:p()) | (RegName :: partisan_remote_ref:n()) | {RegName :: atom(), Node :: node()}.
-type send_after_opts() :: forward_opts() | [{abs, boolean()}].
-type send_dst() :: server_ref() | reference() | port().
-type server_ref() :: partisan_peer_service_manager:server_ref().
-type time() :: non_neg_integer().
-opaque tref()
Link to this section Functions
-spec broadcast(any(), module()) -> ok.
Broadcasts a message originating from this node.
The message will be delivered to each node at least once. TheMod passed is responsible for handling the message on remote nodes as well as providing some other information both locally and and on other nodes. Mod must be loaded on all members of the clusters and implement the partisan_plumtree_broadcast_handler behaviour.
-spec cancel_timer(Ref :: reference(), Opts :: list()) -> ok | time() | false.
-spec cast_message(ServerRef :: server_ref(), Msg :: message()) -> ok.
-spec cast_message(ServerRef :: server_ref(), Msg :: message(), Opts :: forward_opts()) -> ok.
-spec cast_message(Node :: node(), ServerRef :: server_ref(), Msg :: message(), Opts :: forward_opts()) -> ok.
-spec channel_opts(Name :: channel()) -> channel_opts() | no_return().
Name. Fails if a channel named Name doesn't exist.
-spec default_channel() -> channel().
-spec demonitor(MonitorRef :: reference() | partisan_remote_ref:r()) -> true.
-spec demonitor(MonitorRef :: reference() | partisan_remote_ref:r(), OptionList :: [demonitor_opt()]) -> boolean().
-spec disconnect_node(Node :: node()) -> boolean() | ignored.
-spec exit(Pid :: pid() | partisan_remote_ref:p(), Reason :: term()) -> true.
-spec forward_message(ServerRef :: server_ref(), Msg :: message()) -> ok.
-spec forward_message(ServerRef :: server_ref(), Msg :: message(), Opts :: forward_opts()) -> ok.
-spec forward_message(Node :: node(), ServerRef :: server_ref(), Msg :: message(), Opts :: forward_opts()) -> ok.
-spec is_alive() -> boolean().
-spec is_connected(NodeOrSpec :: node_spec() | node()) -> boolean().
-spec is_fully_connected(NodeOrSpec :: node_spec() | node()) -> boolean().
-spec is_local(Arg) -> Result when Arg :: pid() | port() | reference() | partisan_remote_ref:p() | partisan_remote_ref:r(), Result :: boolean().
-spec is_local_name(Arg :: atom() | partisan_remote_ref:n()) -> boolean() | no_return().
-spec is_local_name(Arg :: atom() | partisan_remote_ref:n(), Name :: atom()) -> boolean() | no_return().
-spec is_local_pid(Arg :: pid() | partisan_remote_ref:p()) -> boolean() | no_return().
-spec is_local_pid(Arg :: pid() | partisan_remote_ref:p(), Pid :: pid()) -> boolean() | no_return().
-spec is_local_reference(Arg :: reference() | partisan_remote_ref:r()) -> boolean() | no_return().
-spec is_local_reference(Arg :: reference() | partisan_remote_ref:r(), LocalRef :: reference()) -> boolean() | no_return().
-spec is_pid(pid() | partisan_remote_ref:p()) -> boolean() | no_return().
-spec is_process_alive(pid() | partisan_remote_ref:p()) -> boolean() | no_return().
-spec is_reference(reference() | partisan_remote_ref:r()) -> boolean() | no_return().
-spec is_self(Arg) -> Result when Arg :: pid() | partisan_remote_ref:p(), Result :: boolean().
Arg is the caller's process identifier.
-spec make_ref() -> partisan_remote_ref:r().
partisan_remote_ref:from_term(erlang:make_ref()).
-spec monitor(process, monitor_process_id()) -> reference() | partisan_remote_ref:r() | no_return(); (port, erlang:monitor_port_identifier()) -> reference() | no_return(); (time_offset, clock_service) -> reference() | no_return().
Sends a monitor request of type Type to the entity identified by Item. If the monitored entity does not exist or it changes monitored state, the caller of monitor/2 is notified by a message on the following format: {Tag, MonitorRef, Type, Object, Info}
This is the Partisan's equivalent to erlang:monitor/2.
notalive if the partisan_monitor server is not alive.
-spec monitor(process, monitor_process_id(), [monitor_opt()]) -> reference() | partisan_remote_ref:r(); (port, erlang:monitor_port_identifier(), [erlang:monitor_option()]) -> reference(); (time_offset, clock_service, [erlang:monitor_option()]) -> reference().
Sends a monitor request of type Type to the entity identified by Item. If the monitored entity does not exist or it changes monitored state, the caller of monitor/2 is notified by a message on the following format:
{Tag, MonitorRef, Type, Object, Info}
erlang:monitor/3 only when the item being monitored is a remote process identifier erlang:monitor/3 in which case:MonitorRefis apartisan_remote_ref:r()Objectis apartisan_remote_ref:p()orpartisan_remote_ref:n()
This is the Partisan's equivalent to erlang:monitor/2. It differs from the Erlang implementation only when monitoring a process. For all other cases (monitoring a port or time_offset) this function calls erlang:monitor/2.
As opposed to erlang:monitor/2 this function does not support aliases.
Monitoring a `process`
Creates monitor between the current process and another process identified by Item, which can be a pid() (local or remote), an atom RegisteredName or a tuple {RegisteredName, Node}' for a registered process, located elsewhere.
In the case of a local pid() or a remote pid() A process monitor by name resolves the RegisteredName to pid() or port() only once at the moment of monitor instantiation, later changes to the name registration will not affect the existing monitor.
partisan_monitor server is not alive, a reference will be returned with an immediate 'DOWN' signal with reason notalive.
-spec monitor_node(node() | node_spec(), boolean()) -> boolean().
Monitor the status of the node Node. If Flag is true, monitoring is turned on. If Flag is false, monitoring is turned off.
Making several calls to monitor_node(Node, true) for the same Node from is not an error; it results in as many independent monitoring instances as the number of different calling processes i.e. If a process has made two calls to monitor_node(Node, true) and Node terminates, only one nodedown message is delivered to the process (this differs from erlang:monitor_node/2).
If Node fails or does not exist, the message {nodedown, Node} is delivered to the calling process. If there is no connection to Node, a nodedown message is delivered. As a result when using a membership strategy that uses a partial view, you can not monitor nodes that are not members of the view.
Node is the caller's node, the function returns false.
-spec monitor_nodes(Flag :: boolean()) -> ok | error | {error, term()}.
-spec monitor_nodes(Flag :: boolean(), [monitor_nodes_opt()]) -> ok | error | {error, term()}.
-spec node() -> node().
-spec node(Term) -> Result when Term :: pid() | port() | reference() | partisan_remote_ref:p() | partisan_remote_ref:r(), Result :: node() | no_return().
-spec node_spec() -> node_spec().
Returns the node specification of the local node. This is the information required when other nodes wish to join this node (See partisan_peer_service:join/1).
listen_addrs as it is implemented as a list.
-spec node_spec(node()) -> {ok, node_spec()} | {error, Reason :: any()}.
Return the partisan node_spec() for node named Node.
This function retrieves the node_spec/0 from the remote node using RPC and returns {error, Reason} if the RPC fails. Otherwise, assumes the node is running on the same host and returns a node_spec/0 with with nodename Name and host 'Host' and same metadata as myself/0.
If configuration option connect_disterl is true, the RPC will be implemented using the rpc module. Otherwise it will use partisan_rpc.
connect_disterl is true) or if the node is running on the same host and you are using this for testing purposes as there is no much sense in running a partisan cluster on a single host.
-spec node_spec(Node :: list() | node(), Opts :: #{rpc_timeout => timeout()}) -> {ok, node_spec()} | {error, Reason :: any()}.
Return the tuple {ok, node_spec() for node named Node or the tuple {error, Reason}.
This function first checks If there is a partisan connection to Node, if so returns the cached specification that was used for creating the connection. If no connection is present (the case for a p2p topology), then it tries to use @link partisan_rpc} to retrieve the node specification from the remote node. This later alternative requires the partisan configuration forward_opts` to have `broadcast and transitive enabled.
-spec nodes() -> [node()].
Returns a list of all nodes connected to this node via Partisan. Equivalent to erlang:nodes/1. Sames as calling nodes(visible).
connect_disterl is true (possibly the case when testing), this function will NOT return the disterl nodes. For that you still need to call erlang:nodes/1.
-spec nodes(Arg :: node_type()) -> [node()].
-spec nodestring() -> binary().
-spec process_info(Arg :: pid() | partisan_remote_ref:p()) -> [tuple()] | undefined.
-spec process_info(Arg :: pid() | partisan_remote_ref:p(), Item :: atom() | [atom()]) -> [tuple()] | undefined.
-spec self() -> partisan_remote_ref:p().
Returns the partisan encoded pid for the calling process. This is equivalent to calling partisan_remote_ref:from_term(self()).
self/1 which allows you to cache the result in the process dictionary and take notice of the warning related to doing this on an Erlang Shell process.
-spec self(Opts :: [cache]) -> partisan_remote_ref:p().
Returns the partisan encoded pid for the calling process.
If Opts is the empty list, this is equivalent to calling partisan_remote_ref:from_term(self()).
cache is present in Opts the function lazily caches the result of calling partisan_remote_ref:from_term/1 in the process dictionary the first time and retrieves the value in subsequent calls.NOTICE
You SHOULD avoid using this function in the Erlang Shell. This is because when an Erlang Shell process crashes it will copy the contents of its dictionary to the new shell process and thus you will end up with the wrong partisan remote reference.
-spec send(Dest :: send_dst(), Msg :: message(), Opts :: forward_opts()) -> ok.
-spec send_after(Time :: time(), Destination :: send_after_dst(), Msg :: message()) -> TRef :: reference().
send_after(Time, Dest, Msg, []).
-spec send_after(Time :: time(), Destination :: send_after_dst(), Message :: message(), Opts :: send_after_opts()) -> TRef :: reference().
erlang:send_after/4. It calls the native implementation for local destinations. For remote destinations it spawns a process that uses a timer and accepts cancellation ( via cancel_timer/1,2), so this is less efficient than the native implementation.
-spec spawn(Node :: node(), Fun :: fun(() -> any())) -> partisan_remote_ref:p().
-spec spawn(Node :: node(), Mod :: module(), Function :: atom(), Args :: [term()]) -> partisan_remote_ref:p().
-spec spawn_monitor(Node :: node(), Fun :: fun(() -> any())) -> partisan_remote_ref:p().
-spec spawn_monitor(Node :: node(), Mod :: module(), Function :: atom(), Args :: [term()]) -> partisan_remote_ref:p().
-spec whereis(Arg :: atom() | partisan_remote_ref:n()) -> pid().
badarg if Arg is a remote reference for another node.