Functions related to VM nodes.
Some of the functions in this module are inlined by the compiler,
similar to functions in the Kernel module and they are explicitly
marked in their docs as "inlined by the compiler". For more information
about inlined functions, check out the Kernel module.
alive? :: booleanReturns true if the local node is alive.
That is, if the node can be part of a distributed system.
connect(t) :: boolean | :ignoredEstablishes a connection to node.
Returns true if successful, false if not, and the atom
:ignored if the local node is not alive.
See http://erlang.org/doc/man/net_kernel.html#connect_node-1 for more info.
disconnect(t) :: boolean | :ignoredForces the disconnection of a node.
This will appear to the node as if the local node has crashed.
This function is mainly used in the Erlang network authentication
protocols. Returns true if disconnection succeeds, otherwise false.
If the local node is not alive, the function returns :ignored.
See http://www.erlang.org/doc/man/erlang.html#disconnect_node-1 for more info.
Returns the magic cookie of the local node.
Returns the cookie if the node is alive, otherwise :nocookie.
list :: [t]Returns a list of all visible nodes in the system, excluding the local node.
Same as list(:visible).
list(state | [state]) :: [t]Returns a list of nodes according to argument given.
The result returned when the argument is a list, is the list of nodes satisfying the disjunction(s) of the list elements.
See http://www.erlang.org/doc/man/erlang.html#nodes-1 for more info.
monitor(t, boolean) :: trueMonitors the status of the node.
If flag is true, monitoring is turned on.
If flag is false, monitoring is turned off.
See http://www.erlang.org/doc/man/erlang.html#monitor_node-2 for more info.
monitor(t, boolean, [:allow_passive_connect]) :: trueBehaves as monitor/2 except that it allows an extra
option to be given, namely :allow_passive_connect.
See http://www.erlang.org/doc/man/erlang.html#monitor_node-3 for more info.
ping(t) :: :pong | :pangTries to set up a connection to node.
Returns :pang if it fails, or :pong if it is successful.
iex> Node.ping(:unknown_node)
:pang
Sets the magic cookie of node to the atom cookie.
The default node is Node.self, the local node. If node is the local node,
the function also sets the cookie of all other unknown nodes to cookie.
This function will raise FunctionClauseError if the given node is not alive.
spawn(t, (() -> any)) :: pidReturns the pid of a new process started by the application of fun
on node. If node does not exist, a useless pid is returned.
Check http://www.erlang.org/doc/man/erlang.html#spawn-2 for the list of available options.
Inlined by the compiler.
spawn(t, (() -> any), Process.spawn_opts) :: pid | {pid, reference}Returns the pid of a new process started by the application of fun
on node.
If node does not exist, a useless pid is returned. Check
http://www.erlang.org/doc/man/erlang.html#spawn_opt-3 for the list of
available options.
Inlined by the compiler.
spawn(t, module, atom, [any]) :: pidReturns the pid of a new process started by the application of
module.function(args) on node.
If node does not exist, a useless pid is returned. Check
http://www.erlang.org/doc/man/erlang.html#spawn-4 for the list of
available options.
Inlined by the compiler.
spawn(t, module, atom, [any], Process.spawn_opts) :: pid | {pid, reference}Returns the pid of a new process started by the application of
module.function(args) on node.
If node does not exist, a useless pid is returned. Check
http://www.erlang.org/doc/man/erlang.html#spawn_opt-5 for the list of
available options.
Inlined by the compiler.
spawn_link(t, (() -> any)) :: pidReturns the pid of a new linked process started by the application of fun on node.
A link is created between the calling process and the new process, atomically.
If node does not exist, a useless pid is returned (and due to the link, an exit
signal with exit reason :noconnection will be received).
Inlined by the compiler.
spawn_link(t, module, atom, [any]) :: pidReturns the pid of a new linked process started by the application of
module.function(args) on node.
A link is created between the calling process and the new process, atomically.
If node does not exist, a useless pid is returned (and due to the link, an exit
signal with exit reason :noconnection will be received).
Inlined by the compiler.
start(node, :longnames | :shortnames, non_neg_integer) :: {:ok, pid} | {:error, term}Turns a non-distributed node into a distributed node.
This functionality starts the :net_kernel and other
related processes.
stop :: :ok | {:error, term}Turns a distributed node into a non-distributed node.
For other nodes in the network, this is the same as the node going down.
Only possible when the node was started with Node.start/3, otherwise
returns {:error, :not_allowed}. Returns {:error, :not_found} if the
local node is not alive.