dom/plugins/PPluginStream.ipdl

   1 /* -*- Mode: C++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 8 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Plugins.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *   The Mozilla Foundation <http://www.mozilla.org/>.
  19  * Portions created by the Initial Developer are Copyright (C) 2009
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 include protocol PPluginInstance;
  39
  40 include "mozilla/plugins/PluginMessageUtils.h";
  41
  42 using mozilla::plugins::Buffer;
  43 using NPError;
  44 using NPReason;
  45
  46 namespace mozilla {
  47 namespace plugins {
  48
  49 /**
  50  * PPluginStream represents an NPStream sent from the plugin to the browser.
  51  */
  52
  53 rpc protocol PPluginStream
  54 {
  55   manager PPluginInstance;
  56
  57 parent:
  58   rpc NPN_Write(Buffer data) returns (int32_t written);
  59
  60 both:
  61   /**
  62    * ~PPluginStream is for both NPN_DestroyStream and NPP_DestroyStream.
  63    * @param artificial True when the stream is closed as a by-product of
  64    *                        some other call (such as a failure in NPN_Write).
  65    */
  66   rpc __delete__(NPReason reason, bool artificial);
  67 };
  68
  69 } // namespace plugins
  70 } // namespace mozilla