Узел

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

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

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

Функции

alive?(): Возвращает true, если локальный узел активен.
connect(узел): Устанавливает соединение с node.
disconnect(узел): Вынуждает отключение узла.
get_cookie(): Возвращает магическое cookie локального узла.
list(): Возвращает список всех видимых узлов в системе, исключая локальный узел.
list(аргументы): Возвращает список узлов в соответствии с заданными аргументами.
monitor(узел, флаг): Отслеживает состояние узла.
monitor(узел, флаг, опции): Ведет себя как monitor/2, за исключением того, что позволяет указать дополнительную опцию, а именно :allow_passive_connect.
ping(узел): Пытается установить соединение с узлом.
self(): Возвращает текущий узел.
set_cookie(узел \\ Node.self(), cookie): Устанавливает магическое cookie узла node на атом cookie.
spawn(узел, функция): Возвращает PID нового процесса, запущенного путем применения fun к node. Если node не существует, возвращается бесполезный PID.
spawn(узел, функция, опции): Возвращает PID нового процесса, запущенного путем применения fun к node.
spawn(узел, модуль, функция, аргументы): Возвращает PID нового процесса, запущенного путем применения module.function(args) к node.
spawn(узел, модуль, функция, аргументы, опции): Возвращает PID нового процесса, запущенного путем применения module.function(args) к node.
spawn_link(узел, функция): Возвращает PID нового связанного процесса, запущенного путем применения fun к node.
spawn_link(узел, модуль, функция, аргументы): Возвращает PID нового связанного процесса, запущенного путем применения module.function(args) к node.
start(имя, тип \\ :longnames, время_тикета \\ 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()

Характеристики

get_cookie() :: atom()

Возвращает магическое 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)

Характеристики

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

Устанавливает магическое 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} если локальный узел не активен.