Electron ipcMain 模块

ipcMain 模块是类 EventEmitter 的实例.当在主进程中使用它的时候,它控制着由渲染进程(web page)发送过来的异步或同步消息.从渲染进程发送过来的消息将触发事件.

发送消息

同样也可以从主进程向渲染进程发送消息,查看更多 webContents.send。

一个例子,在主进程和渲染进程之间发送和处理消息:

// 主进程
const ipcMain = require('electron').ipcMain;

//异步消息
ipcMain.on('asynchronous-message', function(event, arg) {
  console.log(arg);  // prints "ping"

  //发送异步消息给渲染进程
  event.sender.send('asynchronous-reply', 'pong');
});

//同步消息
ipcMain.on('synchronous-message', function(event, arg) {
  console.log(arg);  // prints "ping"
  event.returnValue = 'pong';
});
// 渲染进程
const ipcRenderer = require('electron').ipcRenderer;

//同步接收消息
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')); // prints "pong"

//异步接收消息
ipcRenderer.on('asynchronous-reply', function(event, arg) {
  console.log(arg); // prints "pong"
});

//发送异步消息给主进程
ipcRenderer.send('asynchronous-message', 'ping');

监听消息

ipcMain 模块有如下监听事件方法:

ipcMain.on(channel, listener)

  • channel String
  • listener Function

监听 channel, 当新消息到达,将通过 listener(event, args...) 调用 listener

ipcMain.once(channel, listener)

  • channel String
  • listener Function

为事件添加一个一次性用的listener 函数.这个 listener 只有在下次的消息到达 channel 时被请求调用,之后就被删除了。

ipcMain.removeListener(channel, listener)

  • channel String

删除所有监听者,或特指的 channel 的所有监听者。

事件对象

传递给 callbackevent 对象有如下方法:

event.returnValue

将此设置为在一个同步消息中返回的值。

event.sender

返回发送消息的 webContents ,你可以调用 event.sender.send 来回复异步消息,更多信息 webContents.send