pjs/netwerk/base/public/nsIInputStreamChannel.idl

71 строка
2.7 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>
*
* 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 "nsIChannel.idl"
interface nsIInputStream;
/**
* nsIInputStreamChannel
*
* This interface provides methods to initialize an input stream channel.
* The input stream channel serves as a data pump for an input stream.
*/
[scriptable, uuid(560a64ce-6d66-44db-b38e-864469c52d03)]
interface nsIInputStreamChannel : nsIChannel
{
/**
* Sets the URI for this channel.
*/
void setURI(in nsIURI aURI);
/**
* Get/set the content stream
*
* This stream contains the data that will be pushed to the channel's
* stream listener. If the stream is non-blocking and supports the
* nsIAsyncInputStream interface, then the stream will be read directly.
* Otherwise, the stream will be read on a background thread.
*
* This attribute can only be changed before the channel is opened.
*
* @throws NS_ERROR_IN_PROGRESS if the setter is called after the channel
* has been opened.
*/
attribute nsIInputStream contentStream;
};