summaryrefslogtreecommitdiffstats
path: root/dom/chrome-webidl/MozSharedMap.webidl
blob: ef262fc48e5cff4256797db8646c0a4e7e5a521b (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
/* -*- 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, Exposed=Window]
interface MozSharedMapChangeEvent : Event {
  [Cached, Constant]
  readonly attribute sequence<DOMString> changedKeys;
};

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

[ChromeOnly, Exposed=Window]
interface MozSharedMap : EventTarget {
  boolean has(DOMString name);

  [Throws]
  StructuredClonable get(DOMString name);

  iterable<DOMString, StructuredClonable>;
};

[ChromeOnly, Exposed=Window]
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]
  undefined 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.
   */
  undefined delete(DOMString name);

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