From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- dom/cache/StreamControl.h | 92 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 dom/cache/StreamControl.h (limited to 'dom/cache/StreamControl.h') diff --git a/dom/cache/StreamControl.h b/dom/cache/StreamControl.h new file mode 100644 index 000000000..c68d91ff4 --- /dev/null +++ b/dom/cache/StreamControl.h @@ -0,0 +1,92 @@ +/* -*- 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_StreamControl_h +#define mozilla_dom_cache_StreamControl_h + +#include "mozilla/dom/cache/ReadStream.h" +#include "mozilla/RefPtr.h" +#include "nsTObserverArray.h" + +struct nsID; + +namespace mozilla { +namespace ipc { +class AutoIPCStream; +} // namespace ipc +namespace dom { +namespace cache { + +class CacheReadStream; + +// Abstract class to help implement the stream control Child and Parent actors. +// This provides an interface to partly help with serialization of IPC types, +// but also an implementation for tracking ReadStream objects. +class StreamControl +{ +public: + // abstract interface that must be implemented by child class + virtual void + SerializeControl(CacheReadStream* aReadStreamOut) = 0; + + virtual void + SerializeStream(CacheReadStream* aReadStreamOut, nsIInputStream* aStream, + nsTArray>& aStreamCleanupList) = 0; + + // inherited implementation of the ReadStream::Controllable list + + // Begin controlling the given ReadStream. This causes a strong ref to + // be held by the control. The ReadStream must call NoteClosed() or + // ForgetReadStream() to release this ref. + void + AddReadStream(ReadStream::Controllable* aReadStream); + + // Forget the ReadStream without notifying the actor. + void + ForgetReadStream(ReadStream::Controllable* aReadStream); + + // Forget the ReadStream and then notify the actor the stream is closed. + void + NoteClosed(ReadStream::Controllable* aReadStream, const nsID& aId); + +protected: + ~StreamControl(); + + void + CloseReadStreams(const nsID& aId); + + void + CloseAllReadStreams(); + + void + CloseAllReadStreamsWithoutReporting(); + + bool + HasEverBeenRead() const; + + // protected parts of the abstract interface + virtual void + NoteClosedAfterForget(const nsID& aId) = 0; + +#ifdef DEBUG + virtual void + AssertOwningThread() = 0; +#else + void AssertOwningThread() { } +#endif + +private: + // Hold strong references to ReadStream object. When the stream is closed + // it should call NoteClosed() or ForgetReadStream() to release this ref. + typedef nsTObserverArray> ReadStreamList; + ReadStreamList mReadStreamList; +}; + +} // namespace cache +} // namespace dom +} // namespace mozilla + +#endif // mozilla_dom_cache_StreamControl_h -- cgit v1.2.3