Source code

Revision control

Copy as Markdown

Other Tools

/* -*- 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 */
#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;
NS_INLINE_DECL_REFCOUNTING(StreamFilterChild, final)
StreamFilterChild() : mState(State::Uninitialized), mReceivedOnStop(false) {}
enum class State {
// Uninitialized, waiting for constructor response from parent.
// Initialized, but channel has not begun transferring data.
// The stream's OnStartRequest event has been dispatched, and the channel is
// transferring data.
// 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.
// The channel is being suspended, and we're waiting for confirmation of
// suspension from the parent.
// The channel has been suspended in the parent. Data may still be written
// to the output stream listener in this state.
// The channel is suspended. Resume has been called, and we are waiting for
// confirmation of resumption from the parent.
// The close() method has been called, and no further output may be written.
// We are waiting for confirmation from the parent.
// The close() method has been called, and we have been disconnected from
// our parent.
// 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.
// 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.
// An error has occurred and the child is disconnected from the parent.
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);
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;
~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