Spec-Zone.ru › Elixir 1.10

Узел

Функции, связанные с узлами VM.

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

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

Типы

state()
t()

Функции

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()

Возвращает magic 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

Устанавливает magic 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.

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

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

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

Спецификации

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)

stop()

Спецификации

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

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

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

© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.10.4/Node.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API