netwerk/base/MemoryDownloader.h
author Edwin Gao <egao@mozilla.com>
Wed, 13 Mar 2019 19:47:25 +0000
changeset 463893 15c16889e3b7f6e871a518b5f3254459ed5e0213
parent 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1531590, 1531598, 1534811, 1336075, 1531571, 1531572, 1531572, 1531574, 1534855, 1534857, 1535082 - skip tests in mochitest-dev-tools and mochitest-browser-chrome suites for windows10-aarch64 r=jmaher Bug 1531598 - disable browser_markup_copy_image_data.js Bug 1531598 - disable browser_markup_links_04.js Bug 1531598 - disable browser_inspector_menu-01-sensitivity.js Bug 1534811 - disable accessible/tests/browser/general Bug 1336075 - disable browser_largeAllocation_non_win32.js Bug 1531571 - disable browser_jsterm_context_menu_labels.js Bug 1531572 - disable browser_jsterm_helper_dollar_x.js Bug 1531573 - disable browser_jsterm_no_input_and_tab_key_pressed.js Bug 1531574 - disable browser_jsterm_syntax_highlight_output.js Bug 1534855 - disable accessible/tests/browser/ Bug 1534857 - disable browser_ext_slow_script.js Bug 1535082 - disable browser_jsterm_helper_dollar_dollar.js Differential Revision: https://phabricator.services.mozilla.com/D23369

/* -*- Mode: C++; 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/. */

#ifndef mozilla_net_MemoryDownloader_h__
#define mozilla_net_MemoryDownloader_h__

#include "mozilla/UniquePtr.h"
#include "nsCOMPtr.h"
#include "nsIStreamListener.h"
#include "nsTArray.h"

/**
 * mozilla::net::MemoryDownloader
 *
 * This class is similar to nsIDownloader, but stores the downloaded
 * stream in memory instead of a file.  Ownership of the temporary
 * memory is transferred to the observer when download is complete;
 * there is no need to retain a reference to the downloader.
 */

namespace mozilla {
namespace net {

class MemoryDownloader final : public nsIStreamListener {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIREQUESTOBSERVER
  NS_DECL_NSISTREAMLISTENER

  typedef mozilla::UniquePtr<FallibleTArray<uint8_t>> Data;

  class IObserver : public nsISupports {
   public:
    // Note: aData may be null if (and only if) aStatus indicates failure.
    virtual void OnDownloadComplete(MemoryDownloader* aDownloader,
                                    nsIRequest* aRequest, nsISupports* aCtxt,
                                    nsresult aStatus, Data aData) = 0;
  };

  explicit MemoryDownloader(IObserver* aObserver);

 private:
  virtual ~MemoryDownloader() = default;

  static nsresult ConsumeData(nsIInputStream* in, void* closure,
                              const char* fromRawSegment, uint32_t toOffset,
                              uint32_t count, uint32_t* writeCount);

  RefPtr<IObserver> mObserver;
  Data mData;
  nsresult mStatus;
};

}  // namespace net
}  // namespace mozilla

#endif  // mozilla_net_MemoryDownloader_h__