Перейти к основному содержимому
Версия: 2.11

Маршруты

Маршрутные соединения формируют кластер серверов NATS. Протокол очень похож на клиентский. В кластере сервер удобно представлять прокси своих клиентов: он подписывается, отписывается, отправляет и получает сообщения от их имени.

Обзор​

Таблица перечисляет сообщения протокола маршрутов. Как и в клиентском протоколе, имена операций не чувствительны к регистру: SUB foo 1\r\n и sub foo 1\r\n эквивалентны.

СообщениеОтправительОписание
INFOВсе серверыПосле подключения TCP/IP и для обновления сведений о кластере
CONNECTВсе серверыУстанавливает маршрут
RS+Все серверыПодписывает на тему учётной записи от имени заинтересованных клиентов
RS-Все серверыОтменяет подписку, включая автоматическую, на тему учётной записи
RMSGИсходный серверПередаёт сообщение темы и учётной записи другому серверу
PINGВсе серверыПроверка активности PING
PONGВсе серверыОтвет проверки активности PONG
-ERRВсе серверыОшибка протокола, которая может вызвать отключение удалённого сервера

INFO​

Приняв соединение другого сервера, сервер сразу отправляет сведения о себе, конфигурации и требованиях безопасности, необходимых для аутентификации и обмена сообщениями.

Подключающийся сервер тоже отправляет INFO. Принимающий добавляет поле ip с адресом и портом нового сервера и пересылает его INFO всем серверам, с которыми связан маршрутами.

Получив INFO с полем ip, серверы кластера пытаются подключиться по этому адресу, если соединения ещё нет. Такое распространение INFO обеспечивает автоматическое обнаружение новых серверов кластера.

Синтаксис​

INFO {<key>:<value>,...}

Допустимые параметры:

  • server_id: уникальный идентификатор сервера NATS
  • version: версия сервера NATS
  • go: версия Go, которой собран сервер
  • host: хост из параметров кластера
  • port: порт из параметров кластера
  • auth_required: если задано, сервер должен аутентифицироваться при подключении
  • tls_required: если задано, сервер должен аутентифицироваться через TLS
  • max_payload: максимальный принимаемый размер нагрузки
  • connect_urls : список URL серверов для подключения клиента
  • ip: необязательный адрес маршрутного соединения сервера, nats-route://<hostname>:<port>

Пример​

Пример строки INFO, полученной сервером NATS и содержащей ip:

INFO {"server_id":"KP19vTlB417XElnv8kKaC5","version":"2.0.0","go":"","host":"localhost","port":5222,"auth_required":false,"tls_required":false,"tls_verify":false,"max_payload":1048576,"ip":"nats-route://127.0.0.1:5222/","connect_urls":["localhost:4222"]}

CONNECT​

CONNECT аналогичен INFO. Установив TCP/IP-соединение с другим сервером и получив INFO, сервер NATS отправляет CONNECT с дополнительными сведениями о соединении и безопасности.

Синтаксис​

CONNECT {<key>:<value>,...}

Допустимые параметры:

  • tls_required: требуется ли серверу соединение SSL
  • auth_token: токен авторизации
  • user: имя пользователя при заданном auth_required
  • pass: пароль при заданном auth_required
  • name: созданное имя сервера
  • lang: язык реализации сервера (go)
  • version: версия сервера

Пример​

Пример стандартной строки сервера:

CONNECT {"tls_required":false,"name":"wt0vffeQyoDGMVBC2aKX0b"}\r\n

RS+​

RS+ создаёт подписку на тему учётной записи, при необходимости с именем распределённой группы очереди и весом. Подписки групп очередей используют RS+ для увеличения и уменьшения веса, кроме случая нулевого веса.

Синтаксис​

Подписка

RS+ <account> <subject>\r\n

Подписка группы очереди

RS+ <account> <subject> <queue> <weight>\r\n

где:

  • account: учётная запись интереса
  • subject: тема
  • queue: необязательное имя группы очереди
  • weight: необязательный вес группы, представляющий объём интереса или число подписчиков

RS-​

RS- отменяет подписку на тему учётной записи. Сервер отправляет её, когда больше не заинтересован в теме.

Синтаксис​

Подписка

RS- <account> <subject>\r\n

где:

  • account: учётная запись интереса
  • subject: тема

RMSG​

Сообщение протокола RMSG доставляет сообщение другому серверу.

Синтаксис​

RMSG <account> <subject> [reply-to] <bytes>\r\n[payload]\r\n

где:

  • account: учётная запись интереса
  • subject: тема получения сообщения
  • reply-to: необязательная тема ответа
  • bytes: размер нагрузки в байтах
  • payload: полезная нагрузка сообщения

PING/PONG​

PING и PONG реализуют простую проверку активности между серверами. После установления соединения сервер NATS регулярно отправляет PING с настраиваемым интервалом. Если другой сервер не отвечает PONG за заданное время, соединение закрывается. Слишком долгое бездействие соединения приводит к отключению.

На ping другого сервера отправляется pong, подтверждающий присутствие.

Синтаксис​

PING\r\n
PONG\r\n

-ERR​

-ERR используется сервером для сообщения клиенту об ошибке протокола, авторизации или другой ошибке соединения. Большинство таких ошибок закрывает соединение.

Обычно эти ошибки нужно обрабатывать асинхронно.

Синтаксис​

-ERR <error message>