本文へスキップ

MessagePortMain

MessagePortMainは、DOMのMessagePortオブジェクトのメインプロセス側相当です。DOM版と同様に動作しますが、DOMのEventTargetシステムではなく、Node.jsのEventEmitterイベントシステムを使用するという違いがあります。つまり、イベントをリスンするにはport.on('message', ...)を使用する必要があります。port.onmessage = ...またはport.addEventListener('message', ...)は使用できません。

チャネルメッセージングの使用の詳細については、チャネルメッセージングAPIのドキュメントを参照してください。

MessagePortMainEventEmitterです。

クラス: MessagePortMain

メインプロセスにおけるチャネルメッセージング用のポートインターフェース。

プロセス: メイン
このクラスは'electron'モジュールからエクスポートされません。Electron APIの他のメソッドの戻り値としてのみ使用できます。

インスタンスメソッド

port.postMessage(message, [transfer])

  • message 任意
  • transfer MessagePortMain[] (オプション)

ポートからメッセージを送信し、オプションでオブジェクトの所有権を他のブラウジングコンテキストに転送します。

port.start()

ポートにキューに入れられたメッセージの送信を開始します。このメソッドが呼び出されるまで、メッセージはキューに入れられます。

port.close()

ポートを切断し、アクティブではなくなります。

インスタンスイベント

イベント: 'message'

戻り値

  • messageEvent オブジェクト
    • data 任意
    • ports MessagePortMain[]

MessagePortMainオブジェクトがメッセージを受信したときに発生します。

イベント: 'close'

MessagePortMainオブジェクトのリモートエンドが切断されたときに発生します。