@akiroz/pubsub-rpc

A generic RPC mechanism for Pub/Sub transports based on MsgPack

Usage no npm install needed!

<script type="module">
  import akirozPubsubRpc from 'https://cdn.skypack.dev/@akiroz/pubsub-rpc';
</script>

README

PubSub RPC

test

A generic RPC mechanism for Pub/Sub transports based on MsgPack

Supports NodeJS and modern browsers.

Installing

$ yarn add @akiroz/pubsub-rpc

Why not JSON-RPC?

Native binary support for passing large binary payloads.

Mechanism

  1. Callee subscribe to topic
  2. Caller subscribe to topic/${base64(id)}
  3. Caller publish to topic with a binary id (default 16 byte) in the payload
  4. Callee calls RPC handler with params in the payload to get result or error response
  5. Callee publish response to topic/${base64(id)}
  6. Caller unsubscribe from topic/${base64(id)}

API

See tests for a basic use case that simply uses an EventEmitter as the Pub/Sub mechanism.