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

Порты предоставляют механизм для запуска процессов операционной системы, внешних по отношению к виртуальной машине Erlang, и взаимодействия с ними с помощью обмена сообщениями.

Пример

iex> port = Port.open({:spawn, "cat"}, [:binary])
iex> send(port, {self(), {:command, "hello"}})
iex> send(port, {self(), {:command, "world"}})
iex> flush()
{#Port<0.1444>, {:data, "hello"}}
{#Port<0.1444>, {:data, "world"}}
iex> send(port, {self(), :close})
:ok
iex> flush()
{#Port<0.1464>, :closed}
:ok

В примере выше мы создали новый порт, который выполняет программу cat. cat — программа, доступная в операционных системах семейства Unix, которая получает данные из нескольких входных потоков и конкатенирует их в выходе.

После создания порта мы отправили ему два команды в виде сообщений с помощью send/2. Первая команда содержит двоичную нагрузку "hello", а вторая — "world".

После отправки этих двух сообщений, мы вызвали помощника IEx flush(), который напечатал все сообщения, полученные от порта. В данном случае мы получили "hello" и "world" обратно. Обратите внимание, что сообщения являются двоичными, потому что мы передали опцию :binary при открытии порта в Port.open/2. Без этой опции она бы вернула список байтов.

После завершения всех операций мы закрыли порт.

Elixir предоставляет множество удобств для работы с портами и некоторые недостатки. Мы рассмотрим их ниже.

API сообщений и функций

Существует два API для работы с портами. Это может быть либо асинхронный обмен сообщениями, как в примере выше, либо вызов функций в этом модуле.

Ниже приведен список сообщений, поддерживаемых портами, и соответствующие им функции API:

• {pid, {:command, binary}} — отправляет заданные данные на порт. Смотрите command/3.

• {pid, :close} — закрывает порт. Если порт еще не закрыт, порт ответит сообщением {port, :closed} после того, как он осуществит сброс буферов и эффективно закроется. Смотрите close/1.

• {pid, {:connect, new_pid}} — устанавливает new_pid как нового владельца порта. После открытия порта, он связывается и подключается к процессу вызывающего его, и общение с портом происходит только через подключенный процесс. Это сообщение делает new_pid новым подключенным процессом. Если порт не вышел из строя, порт ответит старому владельцу сообщением {port, :connected}. Смотрите connect/2.

В свою очередь, порт будет отправлять подключенному процессу следующие сообщения:

• {port, {:data, data}} — данные, отправленные портом
• {port, :closed} — ответ на сообщение {pid, :close}
• {port, :connected} — ответ на сообщение {pid, {:connect, new_pid}}
• {:EXIT, port, reason} — сигналы завершения в случае сбоя порта. Если причина не :normal, это сообщение будет получено только если процесс-владелец ловит исключения

Механизмы открытия

Порт может быть открыт через четыре основных механизма.

Вкратце, отдавайте предпочтение использованию опций :spawn и :spawn_executable, упомянутых ниже. Два других варианта, :spawn_driver и :fd предназначены для расширенного использования внутри виртуальной машины. Также рассмотрите использование System.cmd/3, если все, что вам нужно, это запуск программы и получение ее возвращаемого значения.

spawn

Кортеж :spawn получает двоичные данные, которые будут выполнены как полное вызов. Например, мы можем использовать его для прямого вызова "echo hello":

iex> port = Port.open({:spawn, "echo hello"}, [:binary])
iex> flush()
{#Port<0.1444>, {:data, "hello\n"}}

:spawn извлечет имя программы из аргумента и пройдет по переменной среды вашей операционной системы $PATH в поисках соответствующей программы.

Хотя это удобно, это означает, что невозможно вызвать исполняемый файл, имя которого содержит пробелы или пробелы в аргументах. По этим причинам чаще всего предпочтительно использовать :spawn_executable.

spawn_executable

Spawn executable — более ограниченная и явная версия spawn. Она ожидает полные пути к исполняемому файлу, который вы хотите выполнить. Если они находятся в вашей $PATH, их можно получить, вызвав System.find_executable/1:

iex> path = System.find_executable("echo")
iex> port = Port.open({:spawn_executable, path}, [:binary, args: ["hello world"]])
iex> flush()
{#Port<0.1380>, {:data, "hello world\n"}}

При использовании :spawn_executable, список аргументов можно передать через опцию :args как показано выше. Полный список опций см. в документации к функции Erlang :erlang.open_port/2.

fd

Опция имени :fd позволяет разработчикам получить доступ к дескрипторам файлов in и out, используемым виртуальной машиной Erlang. Вы будете использовать их только в том случае, если переопределяете основные части системного ядра, такие как процессы :user и :shell.

Процессы операционной системы-зомби

Порт можно закрыть с помощью функции close/1 или отправки сообщения {pid, :close}. Однако, если VM выходит из строя, долго выполняющаяся программа, запущенная портом, будет иметь закрытые каналы stdin и stdout, но не будет автоматически завершена.

Хотя большинство утилит командной строки Unix выходят, как только каналы связи закрываются, не все приложения командной строки делают это. Вы можете легко проверить это, запустив порт, а затем выключив VM и проверив операционную систему, чтобы убедиться, что процесс порта все еще работает.

Хотя мы рекомендуем плавную остановку, обнаруживая, был ли stdin/stdout закрыт, у нас не всегда есть контроль над тем, как прекращает работу стороннее ПО. В таких случаях вы можете обернуть приложение в скрипт, который проверяет stdin. Вот такой скрипт, который был проверен для работы в оболочках bash:

#!/usr/bin/env bash

# Start the program in the background
exec "$@" &
pid1=$!

# Silence warnings from here on
exec >/dev/null 2>&1

# Read from stdin in the background and
# kill running program when stdin closes
exec 0<&0 $(
  while read; do :; done
  kill -KILL $pid1
) &
pid2=$!

# Clean up
wait $pid1
ret=$?
kill -KILL $pid2
exit $ret

Обратите внимание, что программа выше перехватывает stdin, поэтому вы не сможете общаться с базовым программным обеспечением через stdin (с другой стороны, программное обеспечение, которое читает stdin, обычно завершается, когда stdin закрывается).

Теперь вместо:

Port.open(
  {:spawn_executable, "/path/to/program"},
  args: ["a", "b", "c"]
)

Вы можете вызвать:

Port.open(
  {:spawn_executable, "/path/to/wrapper"},
  args: ["/path/to/program", "a", "b", "c"]
)