msgpack-rpc-lite
Implementation of MessagePack-RPC with msgpack-lite
Usage
-
createServer([serverOptions][, codecOptions])
Creates a new MessagePack-RPC server.
serverOptions
<Object> See net.createServer([options][, connectionListener])codecOptions
<Object>encode
See Custom Codec Optionsdecode
See Custom Codec Options
- Returns: <net.Server>
-
Server event: method
Emitted when a new connection is made.
- <Array> request parameters.
- <Function> If a request is received, a callback function is passed.
- To return the results to the client, pass
null
as the first argument and response parameters as the second argument. - If an error occurs, pass it to the first argument.
- To return the results to the client, pass
-
createClient(port[, host][, timeout][, codecOptions])
Initiates a MessagePack-RPC client.
port
<number> Port the socket should connect to.host
<string> Host the socket should connect to. Default:'localhost'
timeout
<number> Sets the socket to timeout after timeout milliseconds of inactivity on the socket. If timeout is 0, then the existing idle timeout is disabled. Default:0
codecOptions
<Object>encode
See Custom Codec Optionsdecode
See Custom Codec Options
- Return: <Client>
-
client.request(method[, ...args])
method
<string>- Return: <Promise>
-
client.notify(method[, ...args])
method
<string>- Return: <Promise>
Examples
-
Server
const rpc = ;const server = rpc;server; -
Client
const rpc = ;const client = rpc;client
Compatibility Mode
Set true
to useraw
of encode
/decode
of Codec-options.
- Clientconst codecOptions = encode: useraw: true decode: useraw: true ;const client = rpc;
See also:
- https://github.com/kawanet/msgpack-lite#compatibility-mode
- https://github.com/msgpack/msgpack/blob/master/spec.md#upgrading-messagepack-specification