summaryrefslogtreecommitdiffstats
path: root/dom/webidl/MessagePort.webidl
blob: 349bf8fbeefd98c3a225109626869d842e6d9e5c (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
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/.
 *
 * For more information on this interface, please see
 * https://html.spec.whatwg.org/#message-ports
 */

[Exposed=(Window,Worker,AudioWorklet)]
interface MessagePort : EventTarget {
  [Throws]
  undefined postMessage(any message, sequence<object> transferable);
  [Throws]
  undefined postMessage(any message, optional StructuredSerializeOptions options = {});

  undefined start();
  undefined close();

  // event handlers
  attribute EventHandler onmessage;
  attribute EventHandler onmessageerror;
};

// Used to declare which objects should be transferred.
dictionary StructuredSerializeOptions {
  sequence<object> transfer = [];
};