mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
122 lines
4.6 KiB
Plaintext
122 lines
4.6 KiB
Plaintext
/* -*- Mode: C++; 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):
|
|
*
|
|
* 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 ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
interface nsIRequest;
|
|
interface nsIEventQueue;
|
|
|
|
/**
|
|
* nsIStreamObserver
|
|
*
|
|
* @status UNDER_REVIEW
|
|
*/
|
|
|
|
[scriptable, uuid(fd91e2e0-1481-11d3-9333-00104ba0fd40)]
|
|
interface nsIStreamObserver : nsISupports
|
|
{
|
|
/**
|
|
* Called to signify the beginning of an asynchronous request.
|
|
*
|
|
* @param request - request being observed
|
|
* @param ctxt - user specified data passed to AsyncRead/Write
|
|
*/
|
|
void onStartRequest(in nsIRequest request,
|
|
in nsISupports ctxt);
|
|
|
|
/**
|
|
* Called to signify the end of an asynchronous request. This
|
|
* call is always preceded by a call to onStartRequest.
|
|
*
|
|
* @param request - request being observed
|
|
* @param ctxt - user specified data passed to AsyncRead/Write
|
|
* @param statusCode - reason for stopping (NS_OK if completed successfully)
|
|
* @param statusText - human readable reason for stopping (can be NULL)
|
|
*/
|
|
void onStopRequest(in nsIRequest request,
|
|
in nsISupports ctxt,
|
|
in nsresult statusCode,
|
|
in wstring statusText);
|
|
};
|
|
|
|
/**
|
|
* A stream observer proxy is used to ship data over to another thread specified
|
|
* by the thread's event queue. The "true" stream observer's methods are
|
|
* invoked on the other thread.
|
|
*
|
|
* This interface only provides the initialization needed after construction. Otherwise,
|
|
* these objects are used simply as nsIStreamObserver's.
|
|
*/
|
|
[scriptable, uuid(3c9b532e-db84-4ecf-aa6a-4d38a9c4c5f0)]
|
|
interface nsIStreamObserverProxy : nsIStreamObserver
|
|
{
|
|
/**
|
|
* Initializes an nsIStreamObserverProxy.
|
|
*
|
|
* @param observer - receives observer notifications on the other thread
|
|
* @param eventQ - may be NULL indicating the calling thread's event queue
|
|
*/
|
|
void init(in nsIStreamObserver observer,
|
|
in nsIEventQueue eventQ);
|
|
};
|
|
|
|
/**
|
|
* An asynchronous stream observer is used to ship data over to another thread specified
|
|
* by the thread's event queue. The receiver stream observer is then used to receive
|
|
* the notifications on the other thread.
|
|
*
|
|
* This interface only provides the initialization needed after construction. Otherwise,
|
|
* these objects are used simply as nsIStreamObservers.
|
|
*/
|
|
[scriptable, uuid(a28dc590-91b3-11d3-8cd9-0060b0fc14a3)]
|
|
interface nsIAsyncStreamObserver : nsIStreamObserver
|
|
{
|
|
/**
|
|
* Initializes an nsIAsyncStreamObserver.
|
|
* @param eventQueue - may be null indicating the calling thread's event queue
|
|
*/
|
|
void init(in nsIStreamObserver receiver,
|
|
in nsIEventQueue eventQueue);
|
|
};
|
|
|
|
%{C++
|
|
// Generic status codes for OnStopRequest:
|
|
#define NS_BINDING_SUCCEEDED NS_OK
|
|
#define NS_BINDING_FAILED NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_NETWORK, 1)
|
|
#define NS_BINDING_ABORTED NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_NETWORK, 2)
|
|
%}
|