dom/fetch/FetchStreamReader.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_FetchStreamReader_h
   8 #define mozilla_dom_FetchStreamReader_h
   9
  10 #include "js/RootingAPI.h"
  11 #include "js/TypeDecls.h"
  12 #include "mozilla/dom/FetchBinding.h"
  13 #include "mozilla/dom/PromiseNativeHandler.h"
  14 #include "nsIAsyncOutputStream.h"
  15 #include "nsIGlobalObject.h"
  16
  17 namespace mozilla {
  18 namespace dom {
  19
  20 class WeakWorkerRef;
  21
  22 class FetchStreamReader final : public nsIOutputStreamCallback,
  23                                 public PromiseNativeHandler {
  24  public:
  25   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  26   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_AMBIGUOUS(
  27       FetchStreamReader, nsIOutputStreamCallback)
  28   NS_DECL_NSIOUTPUTSTREAMCALLBACK
  29
  30   // This creates a nsIInputStream able to retrieve data from the ReadableStream
  31   // object. The reading starts when StartConsuming() is called.
  32   static nsresult Create(JSContext* aCx, nsIGlobalObject* aGlobal,
  33                          FetchStreamReader** aStreamReader,
  34                          nsIInputStream** aInputStream);
  35
  36   void ResolvedCallback(JSContext* aCx, JS::Handle<JS::Value> aValue) override;
  37
  38   void RejectedCallback(JSContext* aCx, JS::Handle<JS::Value> aValue) override;
  39
  40   // Idempotently close the output stream and null out all state. If aCx is
  41   // provided, the reader will also be canceled.  aStatus must be a DOM error
  42   // as understood by DOMException because it will be provided as the
  43   // cancellation reason.
  44   void CloseAndRelease(JSContext* aCx, nsresult aStatus);
  45
  46   void StartConsuming(JSContext* aCx, JS::HandleObject aStream,
  47                       JS::MutableHandle<JSObject*> aReader, ErrorResult& aRv);
  48
  49  private:
  50   explicit FetchStreamReader(nsIGlobalObject* aGlobal);
  51   ~FetchStreamReader();
  52
  53   nsresult WriteBuffer();
  54
  55   void ReportErrorToConsole(JSContext* aCx, JS::Handle<JS::Value> aValue);
  56
  57   nsCOMPtr<nsIGlobalObject> mGlobal;
  58   nsCOMPtr<nsIEventTarget> mOwningEventTarget;
  59
  60   nsCOMPtr<nsIAsyncOutputStream> mPipeOut;
  61
  62   RefPtr<WeakWorkerRef> mWorkerRef;
  63
  64   JS::Heap<JSObject*> mReader;
  65
  66   nsTArray<uint8_t> mBuffer;
  67   uint32_t mBufferRemaining;
  68   uint32_t mBufferOffset;
  69
  70   bool mStreamClosed;
  71 };
  72
  73 }  // namespace dom
  74 }  // namespace mozilla
  75
  76 #endif  // mozilla_dom_FetchStreamReader_h