HttpBackgroundChannelParent.h

Enable keyboard shortcuts

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set sw=2 ts=8 et tw=80 : */

/* 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_HttpBackgroundChannelParent_h

#define mozilla_net_HttpBackgroundChannelParent_h

#include "mozilla/net/PHttpBackgroundChannelParent.h"

#include "mozilla/Atomics.h"

#include "mozilla/Mutex.h"

#include "nsID.h"

#include "nsISupportsImpl.h"

class nsISerialEventTarget;

namespace mozilla {

namespace net {

class HttpChannelParent;

class HttpBackgroundChannelParent final : public PHttpBackgroundChannelParent {

 public:

  explicit HttpBackgroundChannelParent();

  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(HttpBackgroundChannelParent, final)

  // Try to find associated HttpChannelParent with the same

  // channel Id.

  nsresult Init(const uint64_t& aChannelId);

  // Callbacks for BackgroundChannelRegistrar to notify

  // the associated HttpChannelParent is found.

  void LinkToChannel(HttpChannelParent* aChannelParent);

  // Callbacks for HttpChannelParent to close the background

  // IPC channel.

  void OnChannelClosed();

  // To send OnStartRequest message over background channel.

  bool OnStartRequest(const nsHttpResponseHead& aResponseHead,

                      const bool& aUseResponseHead,

                      const nsHttpHeaderArray& aRequestHeaders,

                      const HttpChannelOnStartRequestArgs& aArgs,

                      const nsCOMPtr<nsICacheEntry>& aCacheEntry,

                      TimeStamp aOnStartRequestStart);

  // To send OnTransportAndData message over background channel.

  bool OnTransportAndData(const nsresult& aChannelStatus,

                          const nsresult& aTransportStatus,

                          const uint64_t& aOffset, const uint32_t& aCount,

                          const nsCString& aData,

                          TimeStamp aOnDataAvailableStart);

  // To send OnStopRequest message over background channel.

  bool OnStopRequest(const nsresult& aChannelStatus,

                     const ResourceTimingStructArgs& aTiming,

                     const nsHttpHeaderArray& aResponseTrailers,

                     const nsTArray<ConsoleReportCollected>& aConsoleReports,

                     TimeStamp aOnStopRequestStart);

  // When ODA and OnStopRequest are sending from socket process to child

  // process, this is the last IPC message sent from parent process.

  bool OnConsoleReport(const nsTArray<ConsoleReportCollected>& aConsoleReports);

  // To send OnAfterLastPart message over background channel.

  bool OnAfterLastPart(const nsresult aStatus);

  // To send OnProgress message over background channel.

  bool OnProgress(const int64_t aProgress, const int64_t aProgressMax);

  // To send OnStatus message over background channel.

  bool OnStatus(const nsresult aStatus);

  // To send FlushedForDiversion and DivertMessages messages

  // over background channel.

  bool OnDiversion();

  // To send NotifyClassificationFlags message over background channel.

  bool OnNotifyClassificationFlags(uint32_t aClassificationFlags,

                                   bool aIsThirdParty);

  // To send SetClassifierMatchedInfo message over background channel.

  bool OnSetClassifierMatchedInfo(const nsACString& aList,

                                  const nsACString& aProvider,

                                  const nsACString& aFullHash);

  // To send SetClassifierMatchedTrackingInfo message over background channel.

  bool OnSetClassifierMatchedTrackingInfo(const nsACString& aLists,

                                          const nsACString& aFullHashes);

  nsISerialEventTarget* GetBackgroundTarget();

  using ChildEndpointPromise =

      MozPromise<ipc::Endpoint<extensions::PStreamFilterChild>, bool, true>;

  [[nodiscard]] RefPtr<ChildEndpointPromise> AttachStreamFilter(

      Endpoint<extensions::PStreamFilterParent>&& aParentEndpoint,

      Endpoint<extensions::PStreamFilterChild>&& aChildEndpoint);

  [[nodiscard]] RefPtr<GenericPromise> DetachStreamFilters();

 protected:

  void ActorDestroy(ActorDestroyReason aWhy) override;

 private:

  virtual ~HttpBackgroundChannelParent();

  Atomic<bool> mIPCOpened;

  // Used to ensure atomicity of mBackgroundThread

  Mutex mBgThreadMutex MOZ_UNANNOTATED;

  nsCOMPtr<nsISerialEventTarget> mBackgroundThread;

  // associated HttpChannelParent for generating the channel events

  RefPtr<HttpChannelParent> mChannelParent;

};

}  // namespace net

}  // namespace mozilla

#endif  // mozilla_net_HttpBackgroundChannelParent_h