ipcMain

从主进程到渲染器进程异步通信。

进程:Main

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

发送消息

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

  • 发送消息,事件名为channel
  • 回应同步消息, 你可以设置event.returnValue
  • 回应异步消息, 你可以使用event.sender.send(...)

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

// In main process.
const {ipcMain} = require('electron')
ipcMain.on('asynchronous-message', (event, arg) => {
  console.log(arg)  // prints "ping"
  event.sender.send('asynchronous-reply', 'pong')
})

ipcMain.on('synchronous-message', (event, arg) => {
  console.log(arg)  // prints "ping"
  event.returnValue = 'pong'
})
// In renderer process (web page).
const {ipcRenderer} = require('electron')
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // prints "pong"

ipcRenderer.on('asynchronous-reply', (event, arg) => {
  console.log(arg) // prints "pong"
})
ipcRenderer.send('asynchronous-message', 'ping')

方法

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

ipcMain.on(channel, listener)

  • channelString
  • listenerFunction

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

ipcMain.once(channel, listener)

  • channelString
  • listenerFunction

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

ipcMain.removeListener(channel, listener)

  • channelString
  • listenerFunction

为特定的channel从监听队列中删除特定的listener监听者。

ipcMain.removeAllListeners([channel])

  • channelString (可选)

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

事件对象

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

event.returnValue

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

event.sender

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

results matching ""

    No results matching ""