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

84 строки
3.4 KiB
Plaintext

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla 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/MPL/
*
* 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.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2002
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Darin Fisher <darin@netscape.com> (original author)
*
* 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 MPL, 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 MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsIStreamListener.idl"
interface nsIOutputStream;
interface nsIRequestObserver;
interface nsIEventTarget;
/**
* As data "flows" into a stream listener tee, it is copied to the output stream
* and then forwarded to the real listener.
*/
[scriptable, uuid(62b27fc1-6e8c-4225-8ad0-b9d44252973a)]
interface nsIStreamListenerTee : nsIStreamListener
{
/**
* Initalize the tee.
*
* @param listener
* the original listener the tee will propagate onStartRequest,
* onDataAvailable and onStopRequest notifications to, exceptions from
* the listener will be propagated back to the channel
* @param sink
* the stream the data coming from the channel will be written to,
* should be blocking
* @param requestObserver
* optional parameter, listener that gets only onStartRequest and
* onStopRequest notifications; exceptions threw within this optional
* observer are also propagated to the channel, but exceptions from
* the original listener (listener parameter) are privileged
*/
void init(in nsIStreamListener listener,
in nsIOutputStream sink,
[optional] in nsIRequestObserver requestObserver);
/**
* Initalize the tee like above, but with the extra parameter to make it
* possible to copy the output asynchronously
* @param anEventTarget
* if set, this event-target is used to copy data to the output stream,
* giving an asynchronous tee
*/
void initAsync(in nsIStreamListener listener,
in nsIEventTarget eventTarget,
in nsIOutputStream sink,
[optional] in nsIRequestObserver requestObserver);
};