@spec alive?() :: boolean()

Возвращает true, если локальный узел активен.

То есть, если узел может быть частью распределённой системы.

@spec connect(t()) :: boolean() | :ignored

Устанавливает соединение с node.

Возвращает true в случае успеха, false в случае неудачи и атом :ignored если локальный узел не активен.

Для получения дополнительной информации см. :net_kernel.connect_node/1.

@spec disconnect(t()) :: boolean() | :ignored

Принудительно разрывает соединение с узлом.

Для node это будет выглядеть так, как будто локальный узел упал. Эта функция используется в основном в протоколах проверки подлинности сети Erlang. Возвращает true при успешном разрыве соединения, иначе false. Если локальный узел не активен, функция возвращает :ignored.

Для получения дополнительной информации см. :erlang.disconnect_node/1.

@spec get_cookie() :: atom()

Возвращает магическое cookie локального узла.

Возвращает cookie, если узел активен, иначе :nocookie.

@spec list() :: [t()]

Возвращает список всех видимых узлов в системе, исключая локальный узел.

То же самое, что и list(:visible).

Встроенный компилятором.

@spec list(state() | [state()]) :: [t()]

Возвращает список узлов в соответствии с заданным аргументом.

Результат, возвращаемый при аргументе в виде списка, — это список узлов, удовлетворяющих дизъюнкции элементов списка.

Для получения дополнительной информации см. :erlang.nodes/1.

Встроенный компилятором.

@spec monitor(t(), boolean()) :: true

Отслеживает состояние узла.

Если flag — true, мониторинг включен. Если flag — false, мониторинг выключен.

Для получения дополнительной информации см. :erlang.monitor_node/2.

Для отслеживания изменений состояния всех узлов см. :net_kernel.monitor_nodes/2.

@spec monitor(t(), boolean(), [:allow_passive_connect]) :: true

Поведение аналогично monitor/2, но позволяет указать дополнительный параметр — :allow_passive_connect.

Для получения дополнительной информации см. :erlang.monitor_node/3.

Для отслеживания изменений состояния всех узлов см. :net_kernel.monitor_nodes/2.

@spec ping(t()) :: :pong | :pang

Пытается установить соединение с узлом.

Возвращает :pang в случае неудачи или :pong в случае успеха.

Примеры

iex> Node.ping(:unknown_node)
:pang

@spec self() :: t()

Возвращает текущий узел.

Возвращает то же, что и встроенная функция node().

@spec set_cookie(t(), atom()) :: true

Устанавливает магическое cookie узла node на атом cookie.

По умолчанию узел — Node.self/0, локальный узел. Если node — локальный узел, функция также устанавливает cookie всех других неизвестных узлов на cookie.

Эта функция вызовет FunctionClauseError, если указанный node не активен.

@spec spawn(t(), (-> any())) :: pid()

Возвращает PID нового процесса, запущенного путём применения fun к node. Если node не существует, возвращается бесполезный PID.

Список доступных параметров см. в :erlang.spawn/2.

Встроенный компилятором.

@spec spawn(t(), (-> any()), Process.spawn_opts()) :: pid() | {pid(), reference()}

Возвращает PID нового процесса, запущенного путём применения fun к node.

Если node не существует, возвращается бесполезный PID.

Список доступных параметров см. в :erlang.spawn_opt/3.

Встроенный компилятором.

@spec spawn(t(), module(), atom(), [any()]) :: pid()

Возвращает PID нового процесса, запущенного путём применения module.function(args) к node.

Если node не существует, возвращается бесполезный PID.

Список доступных параметров см. в :erlang.spawn/4.

Встроенный компилятором.

@spec spawn(t(), module(), atom(), [any()], Process.spawn_opts()) ::
  pid() | {pid(), reference()}

Возвращает PID нового процесса, запущенного путём применения module.function(args) к node.

Если node не существует, возвращается бесполезный PID.

Список доступных параметров см. в :erlang.spawn_opt/5.

Встроенный компилятором.

@spec spawn_link(t(), (-> any())) :: pid()

Возвращает PID нового связанного процесса, запущенного путём применения fun к node.

Связь создаётся между вызывающим процессом и новым процессом атомарно. Если node не существует, возвращается бесполезный PID (и из-за связи будет получено сообщение об завершении с причиной :noconnection).

Встроенный компилятором.

@spec spawn_link(t(), module(), atom(), [any()]) :: pid()

Возвращает PID нового связанного процесса, запущенного путём применения module.function(args) к node.

Связь создаётся между вызывающим процессом и новым процессом атомарно. Если node не существует, возвращается бесполезный PID (и из-за связи будет получено сообщение об завершении с причиной :noconnection).

Встроенный компилятором.

@spec spawn_monitor(t(), (-> any())) :: {pid(), reference()}

Запускает заданную функцию на узле, отслеживает её и возвращает её PID и ссылку на отслеживание.

Встроенный компилятором.

@spec spawn_monitor(t(), module(), atom(), [any()]) :: {pid(), reference()}

Запускает указанный модуль и функцию, передавая заданные аргументы на узле, отслеживает его и возвращает его PID и ссылку на отслеживание.

Встроенная компилятором.

@spec start(node(), :longnames | :shortnames, non_neg_integer()) ::
  {:ok, pid()} | {:error, term()}

Преобразует узел, не участвующий в распределённом вычислении, в распределённый узел.

Эта функция запускает :net_kernel и другие связанные процессы.

Эта функция редко используется на практике. Вместо этого узлы называются и запускаются через командную строку, используя флаги --sname и --name. Если вам нужно использовать эту функцию для динамического именования узла, убедитесь, что процесс epmd операционной системы работает, вызвав epmd -daemon.

Вызов этой функции, когда распределение уже запущено, либо через командную строку, либо динамически, вернёт ошибку.

Примеры

{:ok, pid} = Node.start(:example, :shortnames, 15000)

@spec stop() :: :ok | {:error, :not_allowed | :not_found}

Преобразует распределённый узел в узел, не участвующий в распределённом вычислении.

Для других узлов в сети это эквивалентно тому, что узел отключается. Возможен только в том случае, если узел был запущен с Node.start/3, в противном случае возвращает {:error, :not_allowed}. Возвращает {:error, :not_found} если локальный узел не активен.