dom/chrome-webidl/MozSharedMap.webidl
author Narcis Beleuzu <nbeleuzu@mozilla.com>
Sun, 29 Jul 2018 03:55:23 +0300
changeset 483986 aaee68beff800bcf076d9c49b5c1f6531b135579
parent 481426 2ebaf5f8c6055b11b11d7ec334d54ee941115d48
child 491979 b417c2d937e8b0a4987e61b1d47efae4435a3fde
permissions -rw-r--r--
Backed out 2 changesets (bug 1463016, bug 1463291) for geckoview failures Backed out changeset fcfb99baa0f0 (bug 1463291) Backed out changeset 0d69b4fb1ed4 (bug 1463016)

/* -*- 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/.
 */

typedef any StructuredClonable;

[ChromeOnly]
interface MozSharedMapChangeEvent : Event {
  [Cached, Constant]
  readonly attribute sequence<DOMString> changedKeys;
};

dictionary MozSharedMapChangeEventInit : EventInit {
  required sequence<DOMString> changedKeys;
};

[ChromeOnly]
interface MozSharedMap : EventTarget {
  boolean has(DOMString name);

  [Throws]
  StructuredClonable get(DOMString name);

  iterable<DOMString, StructuredClonable>;
};

[ChromeOnly]
interface MozWritableSharedMap : MozSharedMap {
  /**
   * Sets the given key to the given structured-clonable value. The value is
   * synchronously structured cloned, and the serialized value is saved in the
   * map.
   *
   * Unless flush() is called, the new value will be broadcast to content
   * processes after a short delay.
   */
  [Throws]
  void set(DOMString name, StructuredClonable value);

  /**
   * Removes the given key from the map.
   *
   * Unless flush() is called, the removal will be broadcast to content
   * processes after a short delay.
   */
  void delete(DOMString name);

  /**
   * Broadcasts any pending changes to all content processes.
   */
  void flush();
};