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

Prefer event.returnValue to event.result for sync messages.

Browse source
This commit is contained in:
Cheng Zhao 2013-09-20 21:24:04 +08:00
parent 50b5272354
commit b225a59a15
3 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/browser/ipc-browser.md
View file

@ -18,7 +18,7 @@ Emitted when renderer sent a message to the browser.
* `routingId` Integer * `routingId` Integer
Emitted when renderer sent a synchronous message to the browser. The receiver Emitted when renderer sent a synchronous message to the browser. The receiver
should store the result in `event.result`. should store the result in `event.returnValue`.
**Note:** Due to the limitation of `EventEmitter`, returning value in the **Note:** Due to the limitation of `EventEmitter`, returning value in the
event handler has no effect, so we have to store the result by using the event handler has no effect, so we have to store the result by using the

2
docs/api/renderer/ipc-renderer.md
View file

@ -30,7 +30,7 @@ An example of sending synchronous message from renderer to browser:
// In browser: // In browser:
var ipc = require('ipc'); var ipc = require('ipc');
ipc.on('browser-data-request', function(event, processId, routingId, message) { ipc.on('browser-data-request', function(event, processId, routingId, message) {
event.result = 'THIS SOME DATA FROM THE BROWSER'; event.returnValue = 'THIS SOME DATA FROM THE BROWSER';
}); });
``` ```

6
renderer/api/lib/ipc.coffee
View file

@ -16,9 +16,11 @@ class Ipc extends EventEmitter
ipc.send('ATOM_INTERNAL_MESSAGE', args...) ipc.send('ATOM_INTERNAL_MESSAGE', args...)
sendSync: (args...) -> sendSync: (args...) ->
ipc.sendSync('ATOM_INTERNAL_MESSAGE_SYNC', 'sync-message', args...).result msg = ipc.sendSync('ATOM_INTERNAL_MESSAGE_SYNC', 'sync-message', args...)
msg.returnValue ? msg.result
sendChannelSync: (args...) -> sendChannelSync: (args...) ->
ipc.sendSync('ATOM_INTERNAL_MESSAGE_SYNC', args...).result msg = ipc.sendSync('ATOM_INTERNAL_MESSAGE_SYNC', args...)
msg.returnValue ? msg.result
module.exports = new Ipc module.exports = new Ipc