dom/plugins/StreamNotifyChild.h

   1 /* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
   2 /* vim: set sw=2 ts=2 et : */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Plugin App.
  17  *
  18  * The Initial Developer of the Original Code is
  19  *   Chris Jones <jones.chris.g@gmail.com>
  20  * Portions created by the Initial Developer are Copyright (C) 2009
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef mozilla_plugins_StreamNotifyChild_h
  40 #define mozilla_plugins_StreamNotifyChild_h
  41
  42 #include "mozilla/plugins/PStreamNotifyChild.h"
  43
  44 namespace mozilla {
  45 namespace plugins {
  46
  47 class BrowserStreamChild;
  48
  49 class StreamNotifyChild : public PStreamNotifyChild
  50 {
  51   friend class PluginInstanceChild;
  52   friend class BrowserStreamChild;
  53
  54 public:
  55   StreamNotifyChild(const nsCString& aURL)
  56     : mURL(aURL)
  57     , mClosure(NULL)
  58     , mBrowserStream(NULL)
  59   { }
  60
  61   NS_OVERRIDE virtual void ActorDestroy(ActorDestroyReason why);
  62
  63   void SetValid(void* aClosure) {
  64     mClosure = aClosure;
  65   }
  66
  67   void NPP_URLNotify(NPReason reason);
  68
  69 private:
  70   NS_OVERRIDE virtual bool Recv__delete__(const NPReason& reason);
  71
  72   /**
  73    * If a stream is created for this this URLNotify, we associate the objects
  74    * so that the NPP_URLNotify call is not fired before the stream data is
  75    * completely delivered. The BrowserStreamChild takes responsibility for
  76    * calling NPP_URLNotify and deleting this object.
  77    */
  78   void SetAssociatedStream(BrowserStreamChild* bs);
  79
  80   nsCString mURL;
  81   void* mClosure;
  82
  83   /**
  84    * If mBrowserStream is true, it is responsible for deleting this C++ object
  85    * and DeallocPStreamNotify is not, so that the delayed delivery of
  86    * NPP_URLNotify is possible.
  87    */
  88   BrowserStreamChild* mBrowserStream;
  89 };
  90
  91 } // namespace plugins
  92 } // namespace mozilla
  93
  94 #endif