modules/plugin/base/public/nsIHTTPHeaderListener.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  *   Ed Burns <edburns@acm.org>
  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 #include "nsISupports.idl"
  40
  41 /**
  42  * The nsIHTTPHeaderListener interface allows plugin authors to
  43  * access HTTP Response headers after issuing an
  44  * nsIPluginManager::{GetURL,PostURL}() call. <P>
  45
  46  * IMPORTANT NOTE: The plugin author must provide an instance to
  47  * {GetURL,PostURL}() that implements both nsIPluginStreamListener and
  48  * nsIHTTPHeaderListener.  This instance is passed in through
  49  * {GetURL,PostURL}()'s streamListener parameter.  The browser will then
  50  * QI thi streamListener to see if it implements
  51  * nsIHTTPHeaderListener.
  52  */
  53
  54 [scriptable, uuid(ea51e0b8-871c-4b85-92da-6f400394c5ec)]
  55 interface nsIHTTPHeaderListener : nsISupports
  56 {
  57   /**
  58    * Called for each HTTP Response header.
  59    * NOTE: You must copy the values of the params.
  60    */
  61   void newResponseHeader(in string headerName, in string headerValue);
  62
  63   /**
  64    * Called once for the HTTP Response status line.
  65    * Value does NOT include a terminating newline.
  66    * NOTE: You must copy this value.
  67    */
  68   void statusLine(in string line);
  69 };