summaryrefslogtreecommitdiffstats
path: root/devtools/shared/transport/js-window-actor-transport.js
blob: 9f0fb82497c3650b2863ec184601f5ca8f7d4245 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

"use strict";

/**
 * DevTools transport relying on JS Window Actors. This is an experimental
 * transport. It is only used when using the JS Window Actor based frame
 * connector. In that case this transport will be used to communicate between
 * the DevToolsServer living in the parent process and the DevToolsServer
 * living in the process of the target frame.
 *
 * This is intended to be a replacement for child-transport.js which is a
 * message-manager based transport.
 */
class JsWindowActorTransport {
  constructor(jsWindowActor, prefix) {
    this.hooks = null;
    this._jsWindowActor = jsWindowActor;
    this._prefix = prefix;

    this._onPacketReceived = this._onPacketReceived.bind(this);
  }

  _addListener() {
    this._jsWindowActor.on("packet-received", this._onPacketReceived);
  }

  _removeListener() {
    this._jsWindowActor.off("packet-received", this._onPacketReceived);
  }

  ready() {
    this._addListener();
  }

  /**
   * @param {object} options
   * @param {boolean} options.isModeSwitching
   *        true when this is called as the result of a change to the devtools.browsertoolbox.scope pref
   */
  close(options) {
    this._removeListener();
    if (this.hooks.onTransportClosed) {
      this.hooks.onTransportClosed(null, options);
    }
  }

  _onPacketReceived(eventName, { data }) {
    const { prefix, packet } = data;
    if (prefix === this._prefix) {
      this.hooks.onPacket(packet);
    }
  }

  send(packet) {
    this._jsWindowActor.sendPacket(packet, this._prefix);
  }

  startBulkSend() {
    throw new Error("startBulkSend not implemented for JsWindowActorTransport");
  }
}

exports.JsWindowActorTransport = JsWindowActorTransport;