gecko-dev/uriloader/base/nsIDocumentLoaderObserver.idl
dougt%netscape.com 128f95aa9b Relanding Necko Changes.
Revising nsIChannel to allow for overlapped i/o. This consists of three parts:

1. Factoring nsIChannel into a protocol specific part, the nsIChannel, and a socket specific, the nsITransport.
2. Derive the nsIChannel from a nsIRequest.
2. Changes the notification system from necko and the URILoader to pass the nsIRequest interface instead of nsIChannel interface.

This goal stems from wanting to be able to have active AsyncRead and AsyncWrite operations on nsSocketTransport.
This is desired because it would greatly simplify the task of maintaining persistent/reusable socket connections
for FTP, HTTP, and Imap (and potentially other protocols). The problem with the existing nsIChannel interface is
that it does not allow one to selectively suspend just one of the read or write operations while keeping the other active.

r=darin@netscape.com
sr=rpotts@netscape.com
2001-02-21 20:38:08 +00:00

94 lines
3.0 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* 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 Netscape are
* Copyright (C) 1999 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
/* nsIDocumentLoaderObserver -->
*/
#include "nsISupports.idl"
interface nsIDocumentLoader;
interface nsIURI;
interface nsIRequest;
/* we'll be phasing this interface out in place of a new
improved progress sink interface
*/
%{C++
#include "nsString.h"
%}
native nsString(nsString);
[ref] native nsStringRef(nsString);
[scriptable, uuid(f6b4f550-317c-11d2-bd8c-00805f8ae3f4)]
interface nsIDocumentLoaderObserver : nsISupports
{
/**
* Notify the observer that a new document will be loaded.
*
* This notification occurs before any DNS resolution occurs, or
* a connection is established with the server...
*/
void onStartDocumentLoad(in nsIDocumentLoader aLoader, in nsIURI aURL, in string aCommand);
/**
* Notify the observer that a document has been completely loaded.
*/
void onEndDocumentLoad(in nsIDocumentLoader loader, in nsIRequest request, in unsigned long aStatus);
/**
* Notify the observer that the specified nsIURI has just started to load.
*
* This notification occurs after DNS resolution, and a connection to the
* server has been established.
*/
void onStartURLLoad(in nsIDocumentLoader aLoader, in nsIRequest request);
/**
* Notify the observer that progress has occurred in the loading of the
* specified URL...
*/
void onProgressURLLoad(in nsIDocumentLoader aLoader,
in nsIRequest aRequest, in unsigned long aProgress,
in unsigned long aProgressMax);
/**
* Notify the observer that status text is available regarding the URL
* being loaded...
*/
[noscript] void onStatusURLLoad(in nsIDocumentLoader loader, in nsIRequest request, in nsStringRef aMsg);
/**
* Notify the observer that the specified nsIURI has finished loading.
*/
void onEndURLLoad(in nsIDocumentLoader aLoader, in nsIRequest aRequest, in unsigned long aStatus);
};
/* the following is a transition define. nsIDocumentLoaderObserver wasn't scriptable and now it is.
so lots of people refer to the IID using the old non-scriptable generated IID...
*/
%{C++
#define NS_IDOCUMENT_LOADER_OBSERVER_IID NS_IDOCUMENTLOADEROBSERVER_IID
%}