summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/webrequest/StreamFilterChild.h
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/extensions/webrequest/StreamFilterChild.h')
-rw-r--r--toolkit/components/extensions/webrequest/StreamFilterChild.h135
1 files changed, 135 insertions, 0 deletions
diff --git a/toolkit/components/extensions/webrequest/StreamFilterChild.h b/toolkit/components/extensions/webrequest/StreamFilterChild.h
new file mode 100644
index 0000000000..a3873c1283
--- /dev/null
+++ b/toolkit/components/extensions/webrequest/StreamFilterChild.h
@@ -0,0 +1,135 @@
+/* -*- 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_extensions_StreamFilterChild_h
+#define mozilla_extensions_StreamFilterChild_h
+
+#include "StreamFilterBase.h"
+#include "mozilla/extensions/PStreamFilterChild.h"
+#include "mozilla/extensions/StreamFilter.h"
+
+#include "mozilla/LinkedList.h"
+#include "mozilla/dom/StreamFilterBinding.h"
+#include "nsISupportsImpl.h"
+
+namespace mozilla {
+class ErrorResult;
+
+namespace extensions {
+
+using mozilla::dom::StreamFilterStatus;
+using mozilla::ipc::IPCResult;
+
+class StreamFilter;
+
+class StreamFilterChild final : public PStreamFilterChild,
+ public StreamFilterBase {
+ friend class StreamFilter;
+ friend class PStreamFilterChild;
+
+ public:
+ NS_INLINE_DECL_REFCOUNTING(StreamFilterChild, final)
+
+ StreamFilterChild() : mState(State::Uninitialized), mReceivedOnStop(false) {}
+
+ enum class State {
+ // Uninitialized, waiting for constructor response from parent.
+ Uninitialized,
+ // Initialized, but channel has not begun transferring data.
+ Initialized,
+ // The stream's OnStartRequest event has been dispatched, and the channel is
+ // transferring data.
+ TransferringData,
+ // The channel's OnStopRequest event has been dispatched, and the channel is
+ // no longer transferring data. Data may still be written to the output
+ // stream listener.
+ FinishedTransferringData,
+ // The channel is being suspended, and we're waiting for confirmation of
+ // suspension from the parent.
+ Suspending,
+ // The channel has been suspended in the parent. Data may still be written
+ // to the output stream listener in this state.
+ Suspended,
+ // The channel is suspended. Resume has been called, and we are waiting for
+ // confirmation of resumption from the parent.
+ Resuming,
+ // The close() method has been called, and no further output may be written.
+ // We are waiting for confirmation from the parent.
+ Closing,
+ // The close() method has been called, and we have been disconnected from
+ // our parent.
+ Closed,
+ // The channel is being disconnected from the parent, and all further events
+ // and data will pass unfiltered. Data received by the child in this state
+ // will be automatically written to the output stream listener. No data may
+ // be explicitly written.
+ Disconnecting,
+ // The channel has been disconnected from the parent, and all further data
+ // and events will be transparently passed to the output stream listener
+ // without passing through the child.
+ Disconnected,
+ // An error has occurred and the child is disconnected from the parent.
+ Error,
+ };
+
+ void Suspend(ErrorResult& aRv);
+ void Resume(ErrorResult& aRv);
+ void Disconnect(ErrorResult& aRv);
+ void Close(ErrorResult& aRv);
+ void Cleanup();
+
+ void Write(Data&& aData, ErrorResult& aRv);
+
+ State GetState() const { return mState; }
+
+ StreamFilterStatus Status() const;
+
+ void RecvInitialized(bool aSuccess);
+
+ protected:
+ IPCResult RecvStartRequest();
+ IPCResult RecvData(Data&& data);
+ IPCResult RecvStopRequest(const nsresult& aStatus);
+ IPCResult RecvError(const nsCString& aError);
+
+ IPCResult RecvClosed();
+ IPCResult RecvSuspended();
+ IPCResult RecvResumed();
+ IPCResult RecvFlushData();
+
+ void SetStreamFilter(StreamFilter* aStreamFilter) {
+ mStreamFilter = aStreamFilter;
+ }
+
+ private:
+ ~StreamFilterChild() = default;
+
+ void SetNextState();
+
+ void MaybeStopRequest();
+
+ void EmitData(const Data& aData);
+
+ bool CanFlushData() {
+ return (mState == State::TransferringData || mState == State::Resuming);
+ }
+
+ void FlushBufferedData();
+ void WriteBufferedData();
+
+ virtual void ActorDestroy(ActorDestroyReason aWhy) override;
+
+ State mState;
+ State mNextState;
+ bool mReceivedOnStop;
+
+ RefPtr<StreamFilter> mStreamFilter;
+};
+
+} // namespace extensions
+} // namespace mozilla
+
+#endif // mozilla_extensions_StreamFilterChild_h