gecko-dev/netwerk/base/public/nsIStatusCodeEventSink.idl

/* -*- 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) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 */

#include "nsISupports.idl"

interface nsIProgressEventSink;
interface nsIChannel;

/**
 * The nsIStatusCodeEventSink is a temporary interface to allow passing 
 * status codes from the socket threads onto the UI without having to 
 * pass strings. This could eventually go away if the proxy events 
 * stuff can handle nested event loop. dougt is working on that. 
 * We could continue to use this if this seems reasonable enough. 
 */
[scriptable, uuid(6998ff36-1dd2-11b2-9ab7-e72a0f9fdd8c)]
interface nsIStatusCodeEventSink : nsISupports
{

    /**
     * Notify the EventSink with a status code for the URL load.<BR>
     * Use IOService to request converting that code to a string. 
     */
    void onStatus(in nsIProgressEventSink sink,
                in nsIChannel channel,
                in nsISupports ctxt,
                in unsigned long aCode);

};