mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

ipcMain to zh-CN

Browse source
This commit is contained in:
Weiqiang Lin 2017-02-09 17:16:27 +08:00
parent 8f542b1d69
commit c7b639e282
1 changed files with 25 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs-translations/zh-CN/api/ipc-main.md
View file

@ -1,28 +1,32 @@
# ipcMain # ipcMain
> 从主进程到渲染器进程异步通信。
进程：[Main](../glossary.md#main-process)
`ipcMain` 模块是类 `ipcMain` 模块是类
[EventEmitter](https://nodejs.org/api/events.html) 的实例.当在主进程中使用它的时候，它控制着由渲染进程(web page)发送过来的异步或同步消息.从渲染进程发送过来的消息将触发事件. [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) 的实例。当在主进程中使用它的时候，它控制着由渲染进程(web page)发送过来的异步或同步消息。从渲染进程发送过来的消息将触发事件。
## 发送消息 ## 发送消息
同样也可以从主进程向渲染进程发送消息，查看更多 [webContents.send][web-contents-send] . 同样也可以从主进程向渲染进程发送消息，查看更多 [webContents.send][web-contents-send] 。
* 发送消息，事件名为 `channel`. * 发送消息，事件名为 `channel`。
* 回应同步消息, 你可以设置 `event.returnValue`. * 回应同步消息, 你可以设置 `event.returnValue`。
* 回应异步消息, 你可以使用 * 回应异步消息, 你可以使用
`event.sender.send(...)`. `event.sender.send(...)`。
一个例子，在主进程和渲染进程之间发送和处理消息: 一个例子，在主进程和渲染进程之间发送和处理消息：
```javascript ```javascript
// In main process. // In main process.
const ipcMain = require('electron').ipcMain const {ipcMain} = require('electron')
ipcMain.on('asynchronous-message', function (event, arg) { ipcMain.on('asynchronous-message', (event, arg) => {
console.log(arg) // prints "ping" console.log(arg) // prints "ping"
event.sender.send('asynchronous-reply', 'pong') event.sender.send('asynchronous-reply', 'pong')
}) })
ipcMain.on('synchronous-message', function (event, arg) { ipcMain.on('synchronous-message', (event, arg) => {
console.log(arg) // prints "ping" console.log(arg) // prints "ping"
event.returnValue = 'pong' event.returnValue = 'pong'
}) })
@ -30,56 +34,56 @@ ipcMain.on('synchronous-message', function (event, arg) {
```javascript ```javascript
// In renderer process (web page). // In renderer process (web page).
const ipcRenderer = require('electron').ipcRenderer const {ipcRenderer} = require('electron')
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // prints "pong" console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // prints "pong"
ipcRenderer.on('asynchronous-reply', function (event, arg) { ipcRenderer.on('asynchronous-reply', (event, arg) => {
console.log(arg) // prints "pong" console.log(arg) // prints "pong"
}) })
ipcRenderer.send('asynchronous-message', 'ping') ipcRenderer.send('asynchronous-message', 'ping')
``` ```
## 监听消息 ## 方法
`ipcMain` 模块有如下监听事件方法: `ipcMain` 模块有如下监听事件方法：
### `ipcMain.on(channel, listener)` ### `ipcMain.on(channel, listener)`
* `channel` String * `channel` String
* `listener` Function * `listener` Function
监听 `channel`, 当新消息到达，将通过 `listener(event, args...)` 调用 `listener`. 监听 `channel`, 当新消息到达，将通过 `listener(event, args...)` 调用 `listener`。
### `ipcMain.once(channel, listener)` ### `ipcMain.once(channel, listener)`
* `channel` String * `channel` String
* `listener` Function * `listener` Function
为事件添加一个一次性用的`listener` 函数.这个 `listener` 只有在下次的消息到达 `channel` 时被请求调用，之后就被删除了. 为事件添加一个一次性用的`listener` 函数。这个 `listener` 只有在下次的消息到达 `channel` 时被请求调用，之后就被删除了。
### `ipcMain.removeListener(channel, listener)` ### `ipcMain.removeListener(channel, listener)`
* `channel` String * `channel` String
* `listener` Function * `listener` Function
为特定的 `channel` 从监听队列中删除特定的 `listener` 监听者. 为特定的 `channel` 从监听队列中删除特定的 `listener` 监听者。
### `ipcMain.removeAllListeners([channel])` ### `ipcMain.removeAllListeners([channel])`
* `channel` String (可选) * `channel` String (可选)
删除所有监听者，或特指的 `channel` 的所有监听者. 删除所有监听者，或特指的 `channel` 的所有监听者。
## 事件对象 ## 事件对象
传递给 `callback` 的 `event` 对象有如下方法: 传递给 `callback` 的 `event` 对象有如下方法：
### `event.returnValue` ### `event.returnValue`
将此设置为在一个同步消息中返回的值. 将此设置为在一个同步消息中返回的值。
### `event.sender` ### `event.sender`
返回发送消息的 `webContents` ，你可以调用 `event.sender.send` 来回复异步消息，更多信息 [webContents.send][web-contents-send]. 返回发送消息的 `webContents` ，你可以调用 `event.sender.send` 来回复异步消息，更多信息 [webContents.send][web-contents-send]。
[web-contents-send]: web-contents.md#webcontentssendchannel-arg1-arg2- [web-contents-send]: web-contents.md#webcontentssendchannel-arg1-arg2-