7. ipcMain

原文:https://github.com/electron/electron/blob/master/docs/api/ipc-main.md
译者:Lin

从主进程到渲染进程的异步通讯。

线程:主线程

ipcMain模块是一个EventEmitter类的实例。在主线程中使用时,它处理发送自渲染线程(网页)的异步和同步消息。发送自渲染器的消息将会使用这个模块中被分发。

<h2 id="sending-messages">发送消息</h2>

它也可以从主进程发送消息到渲染进程,更多信息请查看webContents.send

  • 当发送一个消息,事件的名字是channel
  • 回复一个同步消息,你需要设置event.returnValue
  • 返回一个异步消息给发送者,你可能使用event.sender.send(...)

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

// 在主进程中。
const {ipcMain} = require('electron')
ipcMain.on('asynchronous-message', (event, arg) => {
    console.log(arg)  // 打印结果是"ping"
    event.sender.send('asynchronous-reply', 'pong')
})

ipcMain.on('synchronous-message', (event, arg) => {
    console.log(arg)  // 打印结果是"ping"
    event.returnValue = 'pong'
})


// 在渲染进程中(网页)。
const {ipcRenderer} = require('electron')
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // 打印结果为"pong"

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

<h2 id="methods">Methods</h2>

ipcMain模块又下面的监听事件的方法:

<h3 id="ipcMain-on"><code>ipcMain.on(channel, listener)</code></h3>

  • channel String类型
  • listener Function类型

监听channel,当一个新的消息送达监听者将会调用listener(event, args...)

<h3 id="ipcMain-once"><code>ipcMain.once(channel, listener)</code></h3>

  • channel String类型
  • listener Function类型

给事件添加一个一次性listener函数。这个监听者只会在下一次一个消息被发送到channel时被调用,调用之后就会被移除。

<h3 id="ipcMain-removeListener"><code>ipcMain.removeListener(channel, listener)</code></h3>

  • channel String类型
  • listener Function类型

通过channel在监听者数组中移除指定的listener

<h3 id="ipcMain-removeAllListeners"><code>ipcMain.removeAllListeners([channel])</code></h3>

  • channel String类型(可选参数)

移除所有监听者,或者指定的channel中的所有监听者。

<h2 id="event-object">Event对象</h2>

通过callback返回的event对象有下面的方法:

<h3 id="event-returnValue"><code>event.returnValue</code></h3>

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

<h3 id="event-sender"><code>event.sender</code></h3>

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,607评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,239评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,960评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,750评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,764评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,604评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,347评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,253评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,702评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,893评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,015评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,734评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,352评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,934评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,052评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,216评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,969评论 2 355

推荐阅读更多精彩内容