summaryrefslogtreecommitdiffstats
path: root/dom/file/ipc/PRemoteLazyInputStream.ipdl
blob: a2bc3a5ca2297d3711f1a43501fbdb8b37c86e16 (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
/* 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 protocol PChildToParentStream;
include protocol PContent;
include protocol PFileDescriptorSet;
include protocol PParentToChildStream;
include protocol PSocketProcess;

include IPCStream;

namespace mozilla {

refcounted protocol PRemoteLazyInputStream
{
  manager PBackground or PContent or PSocketProcess;

parent:
  async StreamNeeded();

  async LengthNeeded();

  // When this is called, the parent releases the inputStream and sends a
  // __delete__.
  async Close();

child:
  async StreamReady(IPCStream? aStream);

  async LengthReady(int64_t aLength);

both:
  // __delete__ can be called by parent and by child for 2 reasons:
  // - parent->child: This happens after a Close(). The child wants to inform
  //                  the parent that no other messages will be dispatched and
  //                  that the channel can be interrupted.
  // - child->parent: before any operation, the child could start a migration
  //                  from the current thread to a dedicated DOM-File one. The
  //                  reason why a __delete__ is sent from child to parent is
  //                  because it doesn't require any additional runnables.
  async __delete__();
};

} // namespace mozilla