CacheStreamControlParent.h

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 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_dom_cache_CacheStreamControlParent_h
#define mozilla_dom_cache_CacheStreamControlParent_h

#include "mozilla/dom/cache/Manager.h"
#include "mozilla/dom/cache/PCacheStreamControlParent.h"
#include "mozilla/dom/cache/StreamControl.h"
#include "nsTObserverArray.h"

namespace mozilla::dom::cache {

class StreamList;

class CacheStreamControlParent final : public PCacheStreamControlParent,
                                       public StreamControl,
                                       Manager::Listener {
  friend class PCacheStreamControlParent;

 public:
  CacheStreamControlParent();

  void SetStreamList(SafeRefPtr<StreamList> aStreamList);

  // Will close all streams. May synchronously free our this, see
  // inherited StreamControl::CloseAllReadStreams.
  void CloseAll();

  // Implicitly called when the last stream goes away.
  void Shutdown();

  // StreamControl methods
  virtual void SerializeControl(CacheReadStream* aReadStreamOut) override;

  virtual void SerializeStream(CacheReadStream* aReadStreamOut,
                               nsIInputStream* aStream) override;

  virtual void OpenStream(const nsID& aId,
                          InputStreamResolver&& aResolver) override;

  void AssertWillDelete();

  void LostIPCCleanup(SafeRefPtr<StreamList> aStreamList);

 private:
  ~CacheStreamControlParent();
  virtual void NoteClosedAfterForget(const nsID& aId) override;

#ifdef DEBUG
  virtual void AssertOwningThread() override;
#endif

  // PCacheStreamControlParent methods
  virtual void ActorDestroy(ActorDestroyReason aReason) override;

  mozilla::ipc::IPCResult RecvOpenStream(const nsID& aStreamId,
                                         OpenStreamResolver&& aResolve);

  mozilla::ipc::IPCResult RecvNoteClosed(const nsID& aId);

  void NotifyCloseAll();

  // Cycle with StreamList via a weak-ref to us.  Cleanup occurs when the actor
  // is deleted by the PBackground manager.  ActorDestroy() then calls
  // StreamList::RemoveStreamControl() to clear the weak ref.
  SafeRefPtr<StreamList> mStreamList;

  NS_DECL_OWNINGTHREAD
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(CacheStreamControlParent, override)
};

}  // namespace mozilla::dom::cache

#endif  // mozilla_dom_cache_CacheStreamControlParent_h