summaryrefslogtreecommitdiffstats
path: root/dom/localstorage/PBackgroundLSSimpleRequest.ipdl
blob: 9a6a22d836d2d91e306f66648a339fbdb5804183 (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
/* 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/. */

include protocol PBackground;

include PBackgroundLSSharedTypes;

namespace mozilla {
namespace dom {

/**
 * Response to a `LSSimpleRequestPreloadedParams` request indicating whether the
 * origin was preloaded.
 */
struct LSSimpleRequestPreloadedResponse
{
  bool preloaded;
};

struct LSSimpleRequestGetStateResponse
{
  LSItemInfo[] itemInfos;
};

/**
 * Discriminated union which can contain an error code (`nsresult`) or
 * particular simple request response.
 */
union LSSimpleRequestResponse
{
  nsresult;
  LSSimpleRequestPreloadedResponse;
  LSSimpleRequestGetStateResponse;
};

/**
 * Simple requests are async-only from both a protocol perspective and the
 * manner in which they're used.  In comparison, PBackgroundLSRequests are
 * async only from a protocol perspective; they are used synchronously from the
 * main thread via LSObject's RequestHelper mechanism.  (With the caveat that
 * nsILocalStorageManager does expose LSRequests asynchronously.)
 *
 * These requests use the common idiom where the arguments to the request are
 * sent in the constructor and the result is sent in the __delete__ response.
 * Request types are indicated by the Params variant used and those live in
 * `PBackgroundLSSharedTypes.ipdlh`.
 */
[ManualDealloc, ChildImpl=virtual, ParentImpl=virtual]
protocol PBackgroundLSSimpleRequest
{
  manager PBackground;

child:
  async __delete__(LSSimpleRequestResponse response);
};

} // namespace dom
} // namespace mozilla