1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3 *
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
8 *
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is Mozilla.
15 *
16 * The Initial Developer of the Original Code is
17 * Netscape Communications Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 2002
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 * Darin Fisher <darin@netscape.com>
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38 #include "nsIChannel.idl"
39
40 interface nsIInputStream;
41
42 /**
43 * nsIInputStreamChannel
44 *
45 * This interface provides methods to initialize an input stream channel.
46 * The input stream channel serves as a data pump for an input stream.
47 */
48 [scriptable, uuid(274c4d7a-2447-4ceb-a6de-80db1b83f5d2)]
49 interface nsIInputStreamChannel : nsISupports
50 {
51 /**
52 * Sets the URI for this channel. This must be called before the
53 * channel is opened, and it may only be called once.
54 */
55 void setURI(in nsIURI aURI);
56
57 /**
58 * Get/set the content stream
59 *
60 * This stream contains the data that will be pushed to the channel's
61 * stream listener. If the stream is non-blocking and supports the
62 * nsIAsyncInputStream interface, then the stream will be read directly.
63 * Otherwise, the stream will be read on a background thread.
64 *
65 * This attribute must be set before the channel is opened, and it may
66 * only be set once.
67 *
68 * @throws NS_ERROR_IN_PROGRESS if the setter is called after the channel
69 * has been opened.
70 */
71 attribute nsIInputStream contentStream;
72 };