gecko-dev/netwerk/protocol/http/public/nsIHttpNotify.idl
timeless%mac.com 69f1c63abe Bugzilla Bug 113885 documentation of nsIHttpNotify :: onExamineResponse is wrong.
the callback is not asynchronous.
sr=darin ... no need for further review.
2001-12-06 22:16:38 +00:00

70 lines
2.9 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Gagan Saksena <gagan@netscape.com> (original author)
* Darin Fisher <darin@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* The internal networking library http interface. External modules
* desiring to receive notification of internal http events implement this
* interface, and pass it into the nsINetModuleMgr Register and Unregister
* methods.
*/
#include "nsINetNotify.idl"
interface nsIHttpChannel;
[scriptable, uuid(5a6dec35-fb37-4460-85bb-1c572521d0cf)]
interface nsIHttpNotify : nsINetNotify
{
/**
* Before an HTTP request is sent to the server, this method is called.
* The implementor of this method can then chose to set any additional
* headers for this request before the request is actually sent to the
* server. The HTTP protocol interpreter blocks on this call until it
* returns.
*/
void onModifyRequest(in nsIHttpChannel httpChannel);
/**
* After an HTTP server response is received, this method is called
* syncronously. The implementor can interrogate the nsIHttpChannel as
* it deems necessary. The HTTP protocol interpreter blocks on this call
* until it returns.
*/
void onExamineResponse(in nsIHttpChannel httpChannel);
};