IPC for Pear
npm install pear-ipc
const IPC = require('pear-ipc')
import IPC from 'pear-ipc'
Create a server/client IPC instance with automatic RPC method setting/handling configured via methods
option.
-
socketPath
<String>
- Path to Unix socket / Windows pipe file -
connectTimeout
<Number[ms]>
- Fail after given milliseconds if unable to connect -
connect
<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][https://github.com/mafintosh/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. -
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
Default method declarations can be found in methods.js.
-
ipc.ready()
- IPC client connect to server / IPC server begin listening -
ipc.client(id)
- get IPC server client instance byipc.id
-
ipc.ref()
- reference as active handle -
ipc.unref()
- unreference as active handle -
ipc.close()
- close the client IPC instance / server IPC instance
-
ipc.id
- Instance ID -
ipc.clients
- IPC server instance array of IPC client instances -
ipc.hasClients
- Boolean. Whether IPC server has client instances -
ipc.userData
- Default:null
. Setipc.userData
to an object to efficiently hold client metadata -
ipc.opening
- Promise that resolves on open -
ipc.opened
- Boolean. IPC client has connected / IPC server has started -
ipc.closing
- Promise that resolves on close -
ipc.closed
- Boolean. IPC client has disconnected / IPC server has shutdown
Apache-2.0