Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
       2             : /* vim: set ts=8 sts=2 et sw=2 tw=80: */
       3             : /* This Source Code Form is subject to the terms of the Mozilla Public
       4             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       5             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
       6             : 
       7             : #ifndef _adivertablechannelparent_h_
       8             : #define _adivertablechannelparent_h_
       9             : 
      10             : #include "nsISupports.h"
      11             : 
      12             : class nsIStreamListener;
      13             : 
      14             : namespace mozilla {
      15             : namespace net {
      16             : 
      17             : // To be implemented by a channel's parent actors, e.g. HttpChannelParent
      18             : // and FTPChannelParent. Used by ChannelDiverterParent to divert
      19             : // nsIStreamListener callbacks from the child process to a new
      20             : // listener in the parent process.
      21           3 : class ADivertableParentChannel : public nsISupports
      22             : {
      23             : public:
      24             :   // Called by ChannelDiverterParent::DivertTo(nsIStreamListener*).
      25             :   // The listener should now be used to received nsIStreamListener callbacks,
      26             :   // i.e. OnStartRequest, OnDataAvailable and OnStopRequest, as if it had been
      27             :   // passed to AsyncOpen for the channel. A reference to the listener will be
      28             :   // added and kept until OnStopRequest has completed.
      29             :   virtual void DivertTo(nsIStreamListener *aListener) = 0;
      30             : 
      31             :   // Called to suspend parent channel in ChannelDiverterParent constructor.
      32             :   virtual nsresult SuspendForDiversion() = 0;
      33             : 
      34             :   // While messages are diverted back from the child to the parent calls to
      35             :   // suspend/resume the channel must also suspend/resume the message diversion.
      36             :   // These two functions will be called by nsHttpChannel and nsFtpChannel
      37             :   // Suspend()/Resume() functions.
      38             :   virtual nsresult SuspendMessageDiversion() = 0;
      39             :   virtual nsresult ResumeMessageDiversion() = 0;
      40             : };
      41             : 
      42             : } // namespace net
      43             : } // namespace mozilla
      44             : 
      45             : #endif