Исходный код Node

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

Некоторые функции в этом модуле инлайнят компилятор, аналогично функциям в модуле 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.
spawn_monitor(node, fun): Запускает заданную функцию на узле, отслеживает ее и возвращает ее PID и ссылку на отслеживание.
spawn_monitor(node, module, fun, args): Запускает заданный модуль и функцию, передавая заданные аргументы на узел, отслеживает его и возвращает его PID и ссылку на отслеживание.
start(name, type \\ :longnames, tick_time \\ 15000): Преобразует нераспределенный узел в распределенный узел.
stop(): Преобразует распределенный узел в нераспределенный узел.

Типы

state()Исходный код

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

t()Исходный код

@type t() :: node()

Функции

alive?()Source

@spec alive?() :: boolean()

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

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

connect(node)Source

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

Устанавливает подключение к node.

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

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

disconnect(node)Source

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

Принудительно разрывает подключение к узлу.

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

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

get_cookie()Source

@spec get_cookie() :: atom()

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

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

list()Source

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

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

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

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

list(args)Source

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

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

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

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

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

monitor(node, flag)Source

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

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

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

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

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

monitor(node, flag, options)Source

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

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

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

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

ping(node)Source

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

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

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

Примеры

iex> Node.ping(:unknown_node)
:pang

self()Source

@spec self() :: t()

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

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

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

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

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

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

Функция вызовет исключение FunctionClauseError, если заданный node не активен.

spawn(node, fun)Source

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

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

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

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

spawn(node, fun, opts)Source

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

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

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

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

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

spawn(node, module, fun, args)Source

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

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

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

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

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

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

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

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

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

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

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

spawn_link(node, fun)Source

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

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

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

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

spawn_link(node, module, fun, args)Source

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

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

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

spawn_monitor(node, fun)Source

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

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

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

spawn_monitor(node, module, fun, args)Source

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

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

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

END_OF_DOCUMENT_MARKER

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

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

stop()Source

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

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

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