Узел

Функции, связанные с узлами виртуальной машины.

Некоторые функции в этом модуле инлайнируются компилятором, аналогично функциям в модуле Kernel, и они явно помечены в своей документации как "инлайнированные компилятором". Для получения дополнительной информации об инлайнированных функциях, ознакомьтесь с модулем Kernel.

Краткое описание

Функции

alive?(): Возвращает true, если локальный узел активен.
connect(node): Устанавливает соединение с node.
disconnect(node): Принудительно разрывает соединение с узлом.
get_cookie(): Возвращает магическое cookie локального узла.
list(): Возвращает список всех видимых узлов в системе, исключая локальный узел.
list(args): Возвращает список узлов в соответствии с заданным аргументом.
monitor(node, flag): Отслеживает состояние узла.
monitor(node, flag, options): Ведёт себя как monitor/2, за исключением возможности передачи дополнительного параметра, а именно :allow_passive_connect.
ping(node): Пытается установить соединение с узлом.
self(): Возвращает текущий узел.
set_cookie(node \\ Node.self(), cookie): Устанавливает магическое cookie узла node в атом cookie.
spawn(node, fun): Возвращает PID нового процесса, запущенного путём применения fun к node. Если node не существует, возвращается бесполезный PID.
spawn(node, fun, opts): Возвращает PID нового процесса, запущенного путём применения fun к node.
spawn(node, module, fun, args): Возвращает PID нового процесса, запущенного путём применения module.function(args) к node.
spawn(node, module, fun, args, opts): Возвращает PID нового процесса, запущенного путём применения module.function(args) к node.
spawn_link(node, fun): Возвращает PID нового связанного процесса, запущенного путём применения fun к node.
spawn_link(node, module, fun, args): Возвращает PID нового связанного процесса, запущенного путём применения module.function(args) к node.
start(name, type \\ :longnames, tick_time \\ 15000): Преобразует узел без распределения в распределённый узел.
stop(): Преобразует распределённый узел в узел без распределения.

Типы

state()

state() :: :visible | :hidden | :connected | :this | :known

t()

t() :: node()

Функции

alive?()

alive?() :: boolean()

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

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

connect(node)

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

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

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

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

disconnect(node)

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

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

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

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

get_cookie()

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

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

list()

list() :: [t()]

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

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

Инлайнируется компилятором.

list(args)

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

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

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

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

Инлайнируется компилятором.

monitor(node, flag)

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

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

Если flag равно true, отслеживание включено. Если flag равно false, отслеживание выключено.

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

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

monitor(node, flag, options)

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

Ведёт себя как monitor/2, за исключением возможности передачи дополнительного параметра, а именно :allow_passive_connect.

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

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

ping(node)

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

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

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

Примеры

iex> Node.ping(:unknown_node)
:pang

self()

self() :: t()

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

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

set_cookie(node \\ Node.self(), cookie)

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

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

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

spawn(node, fun)

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

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

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

Инлайнируется компилятором.

spawn(node, fun, opts)

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

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

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

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

Инлайнируется компилятором.

spawn(node, module, fun, args)

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

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

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

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

Инлайнируется компилятором.

spawn(node, module, fun, args, opts)

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

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

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

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

Инлайнируется компилятором.

spawn_link(node, fun)

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

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

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

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

spawn_link(node, module, fun, args)

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

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

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

start(name, type \\ :longnames, tick_time \\ 15000)

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

Преобразует нераспределённый узел в распределённый узел.

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

stop()

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

Преобразует распределённый узел в нераспределённый.

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