pear-ipc
v3.0.2
Published
IPC for Pear
Downloads
1,147
Readme
pear-ipc
IPC for Pear
npm install pear-ipc
API
const IPC = require('pear-ipc')
import IPC from 'pear-ipc'
const server = new IPC.Server(opts)
Create a server IPC instance with automatic RPC method handling configured via methods
option.
Options
socketPath
<String>
- Path to Unix socket / Windows pipe filemethods
<Array... { id: <Number[int]>, name: <String>, stream: <Boolean(false)>, send: <Boolean(false)> }>
- an index of method descriptions. The order of methods (and their settings) must be consistent across all RPC instances using the same method set. The index of a method in the array is that methods uint identifier.['myMethod']
and[{name: 'myMethod'}]
are equivalent. Generated methods default to being request-based (stream:false
andsend:false
). Settingsend: true
will generate a fire-and-forget method. Settingstream: true
will generate a method that returns a Streamx stream response. For more complex cases, theapi
option can be used to wrap define the instance method. Base Properties and Base Methods are illegal RPC method names. See methods.js for example structure.handlers
-{ [name]: (params) => <Stream|Promise|Any> }
- Handle incoming calls. Property names on thehandlers
object matching names in themethods
array passed the incomingparams
object. It is up to the handler to return the correct response for that method.onpipeline
<Function>
- IPC server pipelines streams returned from handlers to rpc streams. If supplied this function is called each time:onpipeline(src, dst)
stream
<Duplex>
- Advanced. Set a custom transport stream
const client = new IPC.Client(opts)
Create a client IPC instance with automatic RPC method setting configured via methods
option.
Options
socketPath
<String>
- Path to Unix socket / Windows pipe fileconnectTimeout
<Number[ms]>
- Fail after given milliseconds if unable to connectconnect
<Boolean>|<Function>
- If truthy, attempt to connect. If a function, pear-ipc calls it to boot sidecar.methods
<Array... { id: <Number[int]>, name: <String>, stream: <Boolean(false)>, send: <Boolean(false)> }>
- an index of method descriptions. The order of methods (and their settings) must be consistent across all RPC instances using the same method set. The index of a method in the array is that methods uint identifier.['myMethod']
and[{name: 'myMethod'}]
are equivalent. Generated methods default to being request-based (stream:false
andsend:false
). Settingsend: true
will generate a fire-and-forget method. Settingstream: true
will generate a method that returns a Streamx stream response. For more complex cases, theapi
option can be used to wrap define the instance method. Base Properties and Base Methods are illegal RPC method names. See methods.js for example structure.api
{ [name]: (method) => (params) => <Stream|Promise|Any> }
- Define outgoing methods on the RPC instance. Property names on theapi
object matching names in themethods
array will be used to generate instance methods if provided. A tiny-buffer-rpcmethod
object will be passed. Call any/all ofmethod.request
method.send
ormethod.createRequestStream
and make any other calls or alterations as needed.stream
<Duplex>
- Advanced. Set a custom transport stream
Default RPC Methods
Default method declarations can be found in methods.js.
Base Server Methods
ipc.ready()
- begin listeningipc.client(id)
- get IPC server client instance byipc.id
ipc.ref()
- reference as active handleipc.unref()
- unreference as active handleipc.close()
- close the server IPC instance
Base Client Methods
ipc.ready()
- connect to serveripc.ref()
- reference as active handleipc.unref()
- unreference as active handleipc.close()
- close the client IPC instance
Base Server Properties
ipc.id
- Instance IDipc.clients
- IPC server instance array of IPC client instancesipc.hasClients
- Boolean. Whether IPC server has client instancesipc.opening
- Promise that resolves on openipc.opened
- Boolean. Server has startedipc.closing
- Promise that resolves on closeipc.closed
- Boolean. Server has shutdown
Base Client Properties
ipc.id
- Instance IDipc.userData
- Default:null
. Setipc.userData
to an object to efficiently hold client metadataipc.opening
- Promise that resolves on openipc.opened
- Boolean. Client has connectedipc.closing
- Promise that resolves on closeipc.closed
- Boolean. Client has disconnected
License
Apache-2.0