modules/plugin/base/public/nsIPluginStreamListener.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  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 /**
  39  * nsIPluginStreamListener
  40  *
  41  * @status DEPRECATED
  42  *
  43  * Originally published XPCOM Plugin API is now deprecated
  44  * Developers are welcome to use NPAPI, please refer to:
  45  * http://mozilla.org/projects/plugins/
  46  */
  47
  48 #include "nsISupports.idl"
  49 #include "nspluginroot.idl"
  50 #include "nsIPluginStreamInfo.idl"
  51 #include "nsIInputStream.idl"
  52
  53 %{C++
  54 #include "nsplugindefs.h"
  55 %}
  56
  57 /**
  58  * The nsIPluginStreamListener interface defines the minimum set of functionality that
  59  * the browser will support if it allows plugins. Plugins can call QueryInterface
  60  * to determine if a plugin manager implements more specific APIs or other
  61  * browser interfaces for the plugin to use (e.g. nsINetworkManager).
  62  */
  63 [uuid(df055770-5448-11d2-8164-006008119d7a)]
  64 interface nsIPluginStreamListener : nsISupports
  65 {
  66     /**
  67      * Notify the observer that the URL has started to load.  This method is
  68      * called only once, at the beginning of a URL load.<BR><BR>
  69    *
  70    * @param aPluginInfo  - plugin stream info
  71    * @return             - the return value is currently ignored, in the future
  72    * it may be used to cancel the URL load..
  73      */
  74   void onStartBinding(in nsIPluginStreamInfo aPluginInfo);
  75
  76     /**
  77      * Notify the client that data is available in the input stream.  This
  78      * method is called whenver data is written into the input stream by the
  79      * networking library...<BR><BR>
  80      *
  81    * @param aPluginInfo  - plugin stream info
  82    * @param aInputStream - the input stream containing the data. This stream can
  83      * be either a blocking or non-blocking stream.
  84    * @param aLength      - the amount of data that was just pushed into the stream.
  85    * @return             - the return value is currently ignored.
  86      */
  87   void onDataAvailable(in nsIPluginStreamInfo aPluginInfo,
  88                        in nsIInputStream aInputStream,
  89                        in unsigned long aLength);
  90
  91   /**
  92    * Notify the client that data is available in the file.
  93    *
  94    * @param aPluginInfo - plugin stream info
  95    * @param aFileName   - the name of the file containing the data
  96    * @return            - the return value is currently ignored.
  97    */
  98   void onFileAvailable(in nsIPluginStreamInfo aPluginInfo, in string aFileName);
  99
 100         /**
 101      * Notify the observer that the URL has finished loading.  This method is
 102      * called once when the networking library has finished processing the
 103    * URL transaction initiatied via the nsINetService::Open(...) call.<BR><BR>
 104      *
 105      * This method is called regardless of whether the URL loaded successfully.<BR><BR>
 106      *
 107    * @param aPluginInfo - plugin stream info
 108    * @param aStatus     - reason why the stream has been terminated
 109    * @return            - the return value is currently ignored.
 110      */
 111   void onStopBinding(in nsIPluginStreamInfo aPluginInfo, in nsresult aStatus);
 112
 113   /**
 114    * Gets the type of the stream
 115    *
 116    * @param aStreamType - the type of the stream
 117    */
 118   readonly attribute nsPluginStreamType streamType;
 119 };