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

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

Пример

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-подобных операционных системах, которая получает данные с нескольких входов и конкатенирует их в выводе.

После создания порта мы отправили ему два команды в виде сообщений, используя Kernel.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 VM. Вы будете использовать их только если переиспользуете ядро системного времени выполнения, такие как процессы :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"]
)