A safe IPC (Inter-Process Communication) bus for applications built on Electron.
This bus offers a common API for exchanging data between any Electron process : Node, Master and Renderer instances.
- Publish/Subscribe oriented API
- Works with sandboxed renderer process
- Support for renderer affinity (several webpages hosted in the same renderer process)
- Remote calls/events and pending messages management with Services
npm install electron-ipc-busDependencies
- https://github.com/oleics/node-easy-ipc
- https://github.com/pkrumins/node-lazy
- https://github.com/defunctzombie/node-uuid
- http://electron.atom.io/
- http://nodejs.org/
// Load modules
const ipcBusModule = require("electron-ipc-bus");
const electronApp = require('electron').app;
// Configuration
const ipcBusPath = 50494;
// const ipcBusPath = '/myfavorite/path';
// Startup
electronApp.on('ready', function () {
// Create broker
const ipcBusBroker = ipcBusModule.CreateIpcBusBroker(ipcBusPath);
// Start broker
ipcBusBroker.start()
.then((msg) => {
console.log('IpcBusBroker started');
// Create bridge
const ipcBusBridge = ipcBusModule.CreateIpcBusBridge(ipcBusPath);
// Start bridge
ipcBusBridge.start()
.then((msg) => {
console.log('IpcBusBridge started');
// Create clients
const ipcBusClient1 = ipcBusModule.CreateIpcBusClient(ipcBusPath);
const ipcBusClient2 = ipcBusModule.CreateIpcBusClient(ipcBusPath);
Promise.all([ipcBusClient1.connect('client1'), ipcBusClient2.connect('client2')])
.then((msg) => {
// Chatting on channel 'greeting'
ipcBusClient1.addListener('greeting', (ipcBusEvent, greetingMsg) => {
if (ipcBusEvent.request) {
ipcBusEvent.request.resolve('thanks to you, dear #' + ipcBusEvent.sender.name);
}
else {
ipcBusClient1.send('greeting-reply', 'thanks to all listeners')
}
console.log(ipcBusClient1.peer.name + ' received ' + ipcBusEvent.channel + ':' + greetingMsg);
});
ipcBusClient2.addListener('greeting', (ipcBusEvent, greetingMsg) => {
if (ipcBusEvent.request) {
ipcBusEvent.request.resolve('thanks to you, dear #' + ipcBusEvent.sender.name);
}
else {
ipcBusClient2.send('greeting-reply', 'thanks to all listeners')
}
console.log(ipcBusClient2.peer.name + ' received ' + ipcBusEvent.channel + ':' + greetingMsg);
});
ipcBusClient1.addListener('greeting-reply', (ipcBusEvent, greetingReplyMsg) => {
console.log(greetingReplyMsg);
console.log(ipcBusClient1.peer.name + ' received ' + ipcBusEvent.channel + ':' + greetingReplyMsg);
});
ipcBusClient2.send('greeting', 'hello everyone!');
ipcBusClient2.request('greeting', 'hello partner!')
.then((ipcBusRequestResponse) => {
console.log(JSON.stringify(ipcBusRequestResponse.event.sender) + ' replied ' + ipcBusRequestResponse.payload);
})
.catch((err) => {
console.log('I have no friend :-(');
});
ipcBusClient1.request(1000, 'greeting', 'hello partner, please answer within 1sec!')
.then((ipcBusRequestResponse) => {
console.log(JSON.stringify(ipcBusRequestResponse.event.sender) + ' replied ' + ipcBusRequestResponse.payload);
})
.catch((err) => {
console.log('I have no friend :-(');
});
});
});
});
});Dispatching of Node messages is managed by a broker. You can have only one single Broker for the whole application. The broker can be instanciated in a node process or in the master process (not in renderer processes). For performance purpose, it is better to instanciate the broker in an independent node process.
interface IpcBusBroker {
start(timeoutDelay?: number): Promise<string>;
stop(): void;
queryState(): Object;
isServiceAvailable(serviceName: string): boolean;
}const ipcBusModule = require("electron-ipc-bus");
const ipcBusBroker = ipcBusModule.CreateIpcBusBroker([busPath]);The require() call loads the module and CreateIpcBusBroker setups the broker with the busPath. If busPath is not specified, the framework tries to get it from the command line with switch --bus-path.
Example with busPath set by code
// Socket path
const ipcBusBroker = ipcBusModule.CreateIpcBusBroker('/my-ipc-bus-path');// Port number
const ipcBusBroker = ipcBusModule.CreateIpcBusBroker(58666);Example with busPath set by command line:
electron.exe --bus-path=58666const ipcBusBroker = ipcBusModule.CreateIpcBusBroker();- timeoutDelay : number (milliseconds)
ipcBusBroker.start()
.then((msg) => console.log(msg))
.catch((err) => console.log(err))Starts the broker dispatcher. If succeeded the value of msg is 'started' (do not rely on it, subject to change). If failed (timeout or any other internal error), err contains the error message.
ipcBusBroker.stop() var queryState = ipcBusBroker.queryState() Returns the list of pair <channel, peer> subscriptions. Format may change from one version to another. This information can be retrieved from an IpcBusClient through the channel : /electron-ipc-bus/queryState
- serviceName: string
ipcBusBroker.isServiceAvailable('mySettings') Test if a service is started. This information can be retrieved from an IpcBusClient through the channel : /electron-ipc-bus/serviceAvailable
Dispatching of Renderer messages is managed by a bridge. You can have only one single bridge for the whole application. The bridge must be instanciated in the master process only. Without this bridge, Renderer and Node processes are not able to dialog.
interface IpcBusBridge {
start(timeoutDelay?: number): Promise<string>;
stop(): void;
}const ipcBusModule = require("electron-ipc-bus");
const ipcBusBridge = ipcBusModule.CreateIpcBusBridge([busPath]);The require() call loads the module and CreateIpcBusBridge setups the bridge with the busPath. If busPath is not specified, the framework tries to get it from the command line with switch --bus-path.
Example with busPath set by code
// Socket path
const ipcBusBridge = ipcBusModule.CreateIpcBusBridge('/my-ipc-bus-path');// Port number
const ipcBusBridge = ipcBusModule.CreateIpcBusBridge(58666);Example with busPath set by command line:
electron.exe --bus-path=58666const ipcBusBridge = ipcBusModule.CreateIpcBusBridge();- timeoutDelay : number (milliseconds)
ipcBusBridge.start()
.then((msg) => console.log(msg))
.catch((err) => console.log(err))Starts the bridge dispatcher. If succeeded the value of msg is 'started' (do not rely on it, subject to change). If failed (timeout or any other internal error), err contains the error message.
ipcBusBridge.stop() The IpcBusClient is an instance of the EventEmitter class.
When you register a callback to a specified channel. Each time a message is received on this channel, the callback is called. The callback must follow the IpcBusListener signature (see below).
Only one IpcBusClient per Process/Renderer is created. If you ask for more, the same instance will be returned.
interface IpcBusClient extends events.EventEmitter {
readonly peerName: string;
connect(timeoutDelayOrPeerName?: number | string, peerName?: string): Promise<string>;
close(): void;
send(channel: string, ...args: any[]): void;
request(timeoutDelayOrChannel: number | string, ...args: any[]): Promise<IpcBusRequestResponse>;
// EventEmitter overriden API
addListener(channel: string, listener: IpcBusListener): this;
removeListener(channel: string, listener: IpcBusListener): this;
on(channel: string, listener: IpcBusListener): this;
once(channel: string, listener: IpcBusListener): this;
off(channel: string, listener: IpcBusListener): this;
// Added in Node 6...
prependListener(channel: string, listener: IpcBusListener): this;
prependOnceListener(channel: string, listener: IpcBusListener): this;
}const ipcBusModule = require("electron-ipc-bus");
const ipcBus = ipcBusModule.CreateIpcBusClient([busPath]);The require() call loads the module. CreateIpcBus setups the client with the busPath that was used to start the broker. If busPath is not specified, the framework tries to get it from the command line with switch --bus-path.
Example with busPath set by code:
const ipcBus = ipcBusModule.CreateIpcBusClient('/my-ipc-bus-path');Example with busPath set by command line:
electron.exe --bus-path='/my-ipc-bus-path'
const ipcBus = ipcBusModule.CreateIpcBusClient();Example with busPath set by code:
const ipcBus = ipcBusModule.CreateIpcBusClient('/my-ipc-bus-path');Example with busPath set by command line:
electron.exe --bus-path='/my-ipc-bus-path'
const ipcBus = ipcBusModule.CreateIpcBusClient();const ipcBusModule = require("electron-ipc-bus");
const ipcBus = ipcBusModule.CreateIpcBusClient();NOTE: If the renderer is running in sandboxed mode, the above code must be run from the BrowserWindow's preload script (browserify -o BundledBrowserWindowPreload.js -x electron BrowserWindowPreload.js). Otherwise, the Electron's ipcRenderer is not accessible and the client cannot work. Use the code below to make the client accessible to the the Web page scripts.
window.ipcBus = require('electron-ipc-bus').CreateIpcBusClient();For debugging purpose, each IpcBusClient is identified by a peer.
interface IpcBusProcess {
type: string;
pid: number;
}
interface IpcBusPeer {
name: string;
process: IpcBusProcess;
}it contains the name of the peer, this name can be changed during the connection. it contains the process context of the peer : type and pid.
- type: Master, pid : Process Id
- type: Node, pid: Process Id
- type: Renderer, pid: WebContents Id
- timeoutDelayOrPeerName = timeoutDelay: number (milliseconds) | peerName: string
- peerName = peerName: string
Basic usage
ipcBus.connect().then((eventName) => console.log("Connected to Ipc bus !"))Provide a timeout
ipcBus.connect(2000).then((eventName) => console.log("Connected to Ipc bus !"))Provide a peer name
ipcBus.connect('client2').then((eventName) => console.log("Connected to Ipc bus !"))Provide all options
ipcBus.connect(2000, 'client2').then((eventName) => console.log("Connected to Ipc bus !"))For a bus in a renderer, it fails if the Bridge is not started else it fails if the Broker is not started. Most of the functions below will fail if the connection is not established (you have to wait for the connect promise).
ipcBus.close()- channel: string
- listener: IpcBusListener
Listens to channel, when a new message arrives listener would be called with listener(event, args...).
NOTE: on, prependListener, once and prependOnceListener methods are supported as well
- channel: string
- listener: IpcBusListener
Removes the specified listener from the listeners array for the specified channel.
NOTE: off method is supported as well
channel: String (optional)
Removes all listeners, or those of the specified channel.
- event: IpcBusEvent
- ...args: any[]): void
The first parameter of the callback is always an event which contains the channel and the origin of the message (sender).
function HelloHandler(ipcBusEvent, content) {
console.log("Received '" + content + "' on channel '" + ipcBusEvent.channel +"' from #" + ipcBusEvent.sender.peerName)
}
ipcBus.on("Hello!", HelloHandler)- channel: string
- ...args: any[]
Sends a message asynchronously via channel, you can also send arbitrary arguments. Arguments will be serialized in JSON internally and hence no functions or prototype chain will be included.
ipcBus.send("Hello!", { name: "My age !"}, "is", 10)- timeoutDelayOrChannel = timeoutDelay: number (milliseconds) | channel: string
- ...args: any[]
Sends a request message on specified channel. The returned Promise is settled when a result is available.
This function can be used in 2 ways :
-
request(timeoutDelay: number, channel: string, ...args: any[]): Promise < IpcBusRequestResponse > if the first parameter is a number, this parameter timeoutDelay defines how much time we're waiting for the response. The 2nd parameter must be the channel.
-
request(channel: string, ...args: any[]): Promise < IpcBusRequestResponse > The channel is the... channel, a default timeout delay is applied.
The Promise provides an IpcBusRequestResponse object:
interface IpcBusRequestResponse {
event: IpcBusEvent;
payload?: Object | string;
err?: string;
}ipcBus.request("compute", "2*PI*9")
.then(ipcBusRequestResponse) {
console.log("channel = " + ipcBusRequestResponse.event.channel + ", response = " + ipcBusRequestResponse.payload + ", from = " + ipcBusRequestResponse.event.sender.peerName);
}
.catch(ipcBusRequestResponse) {
console.log("err = " + ipcBusRequestResponse.err);
}With timeout
ipcBus.request(2000, "compute", "2*PI*9")
...interface IpcBusEvent {
channel: string;
sender: IpcBusSender {
peerName: string;
};
request?: IpcBusRequest {
resolve(payload: Object | string): void;
reject(err: string): void;
};
}The event object passed to the listener has the following properties:
channel delivering the message
peerName of the sender
If present, the message is a request. Listener can resolve the request by calling event.request.resolve() with the response or can reject the request by calling event.request.reject() with an error message.
The IpcBusService creates an IPC endpoint that can be requested via remote calls and send events.
interface IpcBusService {
start(): void;
stop(): void;
registerCallHandler(name: string, handler: IpcBusServiceCallHandler): void;
sendEvent(eventName: string, ...args: any[]): void;
}Message sent to a service to execute a remote call.
interface IpcBusServiceCall {
handlerName: string;
args: any[];
}Prototype of a method that will be executed to handle a service's call.
interface IpcBusServiceCallHandler {
(call: IpcBusServiceCall, request: IpcBusRequest): void;
}const ipcBusModule = require("electron-ipc-bus");
...
// ipcBusClient is a connected instance of IpcBusClient
const ipcMyService = ipcBusModule.CreateIpcBusService(ipcBusClient, 'myService');const ipcBusModule = require("electron-ipc-bus");
...
const myOuterServiceInstance = {};
myOuterServiceInstance.test = () => { return 'This is a test'; };
...
// ipcBusClient is a connected instance of IpcBusClient
const ipcMyService = ipcBusModule.CreateIpcBusService(ipcBusClient, 'myService', myOuterServiceInstance);NOTE : This constructor will automatically register all methods of myOuterServiceImpl as call handlers using registerCallHandler().
This makes the service to listen and serve incoming remote calls. The service also sends the IPCBUS_SERVICE_EVENT_START event. NOTE : If an outerrouter service's instance has been specified at construction time, start() will overload its This method will overload
This makes the service to stop listen and serve incoming remote calls. The service also sends the IPCBUS_SERVICE_EVENT_STOP event.
- name: string
- handler: IpcBusServiceCallHandler This sets the function that will be executed to serve the specified remote call. As this is run in the context of a promise, the function must call either request.resolve() or request.reject() to fulfill the promise.
ipcMyService.registerCallHandler('getCurrentTime', (call, request) => {
try { {
request.resolve(new Date().getTime());
} catch(e) {
request.reject(e);
}
});- name: string
- args: any[] This sends a service event message.
ipcMyService.sendEvent('timeChanged', new Date().getTime());The IpcBusServiceProxy creates an IPC endpoint that can be used to execute calls on a service and listen its events.
interface IpcBusServiceProxy extends events.EventEmitter {
readonly isStarted: boolean;
getStatus(): Promise<ServiceStatus>;
call<T>(handlerName: string, ...args: any[]): Promise<T>;
getWrapper<T>(): T;Message sent to a service's proxy to trigger the code associated to this event.
interface IpcBusServiceEvent {
eventName: string;
args: any[];
}Prototype of a method that will be executed to handle a service's call.
interface IpcBusServiceEventHandler {
(event: IpcBusServiceEvent): void;
}const ipcBusModule = require("electron-ipc-bus");
...
// ipcBusClient is a connected instance of IpcBusClient
const ipcMyServiceProxy = ipcBusModule.CreateIpcBusServiceProxy(ipcBusClient, 'myService', 2000); // 2000 ms for call timeout (default is 1000 ms)Availability of the associated service (available means that the service is started).
This asynchronously requests the service availability to the Broker.
ipcMyServiceProxy.checkAvailability()
.then(
(availability) => console.log(`MyService availability = ${availability}`),
(err) => console.log(`Failed to get MyService availability (${err})`));- handlerName: string
- timeout: number
- args: any[] This sends a service event message.
ipcMyServiceProxy.call('getCurrentTime')
.then(
(currentTime) => console.log(`Current Time = ${currentTime}`),
(err) => console.log(`Failed to get current time : ${err}`));This allow to handle events emitted by remote RPC service. Please refers to the EventEmitter class documentation for more information.
- addListener(event: string, listener: IpcBusServiceEventHandler): this;
- removeListener(event: string, listener: IpcBusServiceEventHandler): this;
- on(event: string, listener: IpcBusServiceEventHandler): this;
- once(event: string, listener: IpcBusServiceEventHandler): this;
- off(event: string, listener: IpcBusServiceEventHandler): this;
- removeAllListeners(event?: string): this;
- prependListener(event: string, listener: IpcBusServiceEventHandler): this;
- prependOnceListener(event: string, listener: IpcBusServiceEventHandler): this;
The wrapper implements EventEmitter as well. If the interface of the service emits an event it will be receiced by the wrapper of the proxy.
The test-app folder contains all sources of the testing application.
NOTE: This folder is not packaged by NPM.
To build the application:
cd examples
cd test-app
npm install
npm run build
To run the application:
npm run start
To run the application in sandboxed mode:
npm run start-sandboxed
- Support several brokers each with its own buspath in order to distribute the traffic load.
- Add an optional spy for debugging purpose
Copyright (c) 2017 Michael Vasseur and Emmanuel Kimmerlin
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.