Back to index

lightning-sunbird  0.9+nobinonly
nsIHttpChannel.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Gagan Saksena <gagan@netscape.com> (original author)
00024  *   Darin Fisher <darin@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "nsIChannel.idl"
00041 
00042 interface nsIHttpHeaderVisitor;
00043 
00053 [scriptable, uuid(9277fe09-f0cc-4cd9-bbce-581dd94b0260)]
00054 interface nsIHttpChannel : nsIChannel
00055 {
00056     /**************************************************************************
00057      * REQUEST CONFIGURATION
00058      *
00059      * Modifying request parameters after asyncOpen has been called is an error.
00060      */
00061 
00075     attribute ACString requestMethod;
00076 
00092     attribute nsIURI referrer;
00093 
00104     ACString getRequestHeader(in ACString aHeader);
00105 
00133     void setRequestHeader(in ACString aHeader,
00134                           in ACString aValue,
00135                           in boolean aMerge);
00136 
00144     void visitRequestHeaders(in nsIHttpHeaderVisitor aVisitor);
00145 
00160     attribute boolean allowPipelining;
00161 
00174     attribute unsigned long redirectionLimit;
00175 
00176 
00177     /**************************************************************************
00178      * RESPONSE INFO
00179      *
00180      * Accessing response info before the onStartRequest event is an error.
00181      */
00182 
00189     readonly attribute unsigned long responseStatus;
00190 
00201     readonly attribute ACString responseStatusText;
00202 
00216     readonly attribute boolean requestSucceeded;
00217 
00231     ACString getResponseHeader(in ACString header);
00232 
00260     void setResponseHeader(in ACString header,
00261                            in ACString value,
00262                            in boolean merge);
00263 
00275     void visitResponseHeaders(in nsIHttpHeaderVisitor aVisitor);
00276 
00284     boolean isNoStoreResponse();
00285 
00295     boolean isNoCacheResponse();
00296 };