jsonrpc-client-http-nats v1.3.2

Клиент для запросов по протоколу JsonRPC через HTTP(s) и Nats

Установка

npm install jsonrpc-client-http-nats --save

Использование

// Подключаем библиотеку
const JsonRPCClient = require('jsonrpc-client-http-nats');

// Создаем клиент для обращения по HTTP(s)
let httpClient = JsonRPCClient.http('http://127.0.0.1:8080');

// И(или) создадаем клиент для обращения через Nats с запросами в канал MyChannel
let natsClient = JsonRPCClient.nats('nats://127.0.0.1:4222', 'MyChannel');

// Отправляем запрос через HTTP(s)
httpClient.request('FirstMethod', { title: 'MyTitle' }, (err, result)=>{
    console.log(err, result);
})

// Отправляем запрос через Nats
natsClient.request('SecondMethod', { title: 'MyData' }, (err, result)=>{
    console.log(err, result);
})


// Подписываемся на канал по Nats (ожидаются строка JSON данные)
natsClient.subscribe('Channel');
natsClient.on('message', (message) => {
  console.log('message);
})

API

Инициализация клиента

JsonRPCClient.http(url [, timeout]) - инициализация экземпляра клиента, общающегося через HTTP(S). Имеет два аргумента:

• url - URL для отравки запросов на сервер, например http://127.0.0.1:8080;
• timeout - время ожидания ответа на запрос в миллисекундах. Если не передан, то равняется 1000;

JsonRPCClient.nats(options, channel [, timeout]) - инициализация экземпляра клиента, общающегося через Nats. Имеет три аргумента:

• options - может быть:
  • объектом options для установки соединения с Nats согласно его документации;
  • URL для подключени, например: nats://127.0.0.1:4222;
  • результат выполнения nats.connect(), см. примечение ниже;
• channel - канал, на котором сервер (например JsonRPC-Server) слушает запросы от клиента;
• timeout - время ожидания ответа на запрос в миллисекундах. Если не передан, то равняется 1000; Примечание: При создании каждого нового экземпляра клиента, если в качестве первого аргумента переданы параметры соединения или URL, создается новое подключение к серверу Nats. Если есть необходимость отправлять запросы на разные каналы одного сервера, имеет смысл в качестве options передать уже готовое подключение, чтобы все клиенты могли его использовать:

  const Nats = require('nats'),
     JsonRPCClientNats = require('jsonrpc-client-nats');

// Устанавливаем соединение с сервером Nats const connection = Nats.connect({ url: 'nats://127.0.0.1:4222' });

// Создаем экземпляры клиентов, использующих одно подключение let clientOne = JsonRPCClient.nats(connection, 'MyChannelOne') let clientTwo = JsonRPCClient.nats(connection, 'MyChannelTwo')

#### Методы экземпляра клиента
`.request(method, [params [, timeout]], callback)` - отправляет запрос в канал и ожидает ответа. Аргументы метода:
 - `method` - метод JsonRPC, строка
 - `params` - параметры, не является обязательным и может быть любого типа
 - `timeout` - время ожидания ответа для запроса, если оно должно отличаться от времени заданном в конструкторе или по умолчанию. При использовании этого аргумента, указание аргумента `params` обязательно.
 - `callback` - функция, которая будет выполнена при получении ответа или ошибки. В функцию будут переданы два аргумента:
   - `error` - ошибка в стандарте JsonRPC, например `{ message: "Error message", code: 1}` или `undefined`, если запрос выполнен успешно;
   - `result` - результат выполнения метода или `undefined`, если присутствует ошибка.