ipc/glue/InputStreamParams.ipdlh

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 include ProtocolTypes;
   6
   7 include protocol PChildToParentStream;
   8 include protocol PParentToChildStream;
   9 include protocol PRemoteLazyInputStream;
  10
  11 using struct mozilla::void_t
  12   from "ipc/IPCMessageUtils.h";
  13
  14 namespace mozilla {
  15 namespace ipc {
  16
  17 struct HeaderEntry
  18 {
  19   nsCString name;
  20   nsCString value;
  21 };
  22
  23 struct StringInputStreamParams
  24 {
  25   nsCString data;
  26 };
  27
  28 struct FileInputStreamParams
  29 {
  30   uint32_t fileDescriptorIndex;
  31   int32_t behaviorFlags;
  32   int32_t ioFlags;
  33 };
  34
  35 struct MultiplexInputStreamParams
  36 {
  37   InputStreamParams[] streams;
  38   uint32_t currentStream;
  39   nsresult status;
  40   bool startedReadingCurrent;
  41 };
  42
  43 struct SlicedInputStreamParams
  44 {
  45   InputStreamParams stream;
  46   uint64_t start;
  47   uint64_t length;
  48   uint64_t curPos;
  49   bool closed;
  50 };
  51
  52 struct RemoteLazyInputStreamRef
  53 {
  54   nsID id;
  55   uint64_t start;
  56   uint64_t length;
  57 };
  58
  59 union RemoteLazyInputStreamParams
  60 {
  61   RemoteLazyInputStreamRef;
  62   PRemoteLazyInputStream;
  63 };
  64
  65 union IPCRemoteStreamType
  66 {
  67   PChildToParentStream;
  68   PParentToChildStream;
  69 };
  70
  71 struct IPCRemoteStreamParams
  72 {
  73   // If this is true, the stream will send data only when the first operation
  74   // is done on the destination side. The benefit of this is that we do not
  75   // send data if not needed. On the other hand, it could have a performance
  76   // issue.
  77   bool delayedStart;
  78
  79   IPCRemoteStreamType stream;
  80
  81   int64_t length;
  82 };
  83
  84 union InputStreamParams
  85 {
  86   StringInputStreamParams;
  87   FileInputStreamParams;
  88   BufferedInputStreamParams;
  89   MIMEInputStreamParams;
  90   MultiplexInputStreamParams;
  91   SlicedInputStreamParams;
  92   RemoteLazyInputStreamParams;
  93   InputStreamLengthWrapperParams;
  94   IPCRemoteStreamParams;
  95   EncryptedFileInputStreamParams;
  96 };
  97
  98 struct EncryptedFileInputStreamParams
  99 {
 100   FileInputStreamParams fileInputStreamParams;
 101   uint8_t[] key;
 102   uint32_t blockSize;
 103 };
 104
 105 struct BufferedInputStreamParams
 106 {
 107   InputStreamParams? optionalStream;
 108   uint32_t bufferSize;
 109 };
 110
 111 struct MIMEInputStreamParams
 112 {
 113   InputStreamParams? optionalStream;
 114   HeaderEntry[] headers;
 115   bool startedReading;
 116 };
 117
 118 struct InputStreamLengthWrapperParams
 119 {
 120   InputStreamParams stream;
 121   int64_t length;
 122   bool consumed;
 123 };
 124
 125 } // namespace ipc
 126 } // namespace mozilla