protomux-rpc-client-pool

1.0.0 • Public • Published

Protomux RPC Client Pool

Reliably connect to one of a pool of protomux-rpc servers.

Picks a random server to connect to, and keeps connecting to that server, unless it fails to respond, in which case it automatically switches over to another one.

Install

npm i protomux-rpc-client-pool

API

const pool = new ProtomuxRpcClientPool(keys, rpcClient, opts)

Create a new pool. keys is a list of HyperDHT servers that expose the same protomux-rpc service. rpcClient is a Protomux RPC client instance.

opts include:

  • retries : the number of times to retry a request with a different server before giving up. Default: 3.
  • timeout : the default timeout for a single request attempt, in ms. Note that the maximal total time for a pool.request(...) call is roughly retries * timeout.

await pool.makeRequest(methodName, args, opts)

Makes a request for the specifed methodName to one of the servers in the pool, passing the args. If the server fails to respond, it automatically retries with other servers.

Throws a ProtomuxRpcClientPoolError.TOO_MANY_RETRIES error if the request attempt fails pool.retries times.

opts include:

  • requestEncoding the request encoding of the RPC service
  • responseEncoding the response encoding of the RPC service
  • timeout the timeout to use for each request attempt (in ms). Defaults to pool.timeout.

Readme

Keywords

Package Sidebar

Install

npm i protomux-rpc-client-pool

Weekly Downloads

916

Version

1.0.0

License

Apache-2.0

Unpacked Size

16.1 kB

Total Files

5

Last publish

Collaborators

  • mafintosh
  • hdegroote