netwerk/base/public/nsIMultiPartChannel.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.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Radha Kulkarni(radha@netscape.com)
  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 interface nsIChannel;
  42
  43 /**
  44  * An interface to access the the base channel
  45  * associated with a MultiPartChannel.
  46  */
  47
  48 [scriptable, uuid(ba78db7b-b88c-4b76-baf9-3c2296a585ae)]
  49 interface nsIMultiPartChannel : nsISupports
  50 {
  51     /**
  52      * readonly attribute to access the underlying channel
  53      */
  54     readonly attribute nsIChannel baseChannel;
  55
  56     /**
  57      * Access to the Content-Disposition header field of this part of
  58      * a multipart message.  This allows getting the preferred
  59      * handling method, preferred filename, etc.  See RFC 2183.
  60      */
  61     attribute ACString contentDisposition;
  62
  63     /**
  64      * Attribute guaranteed to be different for different parts of
  65      * the same multipart document.
  66      */
  67     readonly attribute PRUint32 partID;
  68
  69     /**
  70      * Set to true when onStopRequest is received from the base channel.
  71      * The listener can check this from its onStopRequest to determine
  72      * whether more data can be expected.
  73      */
  74     readonly attribute boolean isLastPart;
  75 };