netwerk/base/public/nsIBufferedStreams.idl

branch
TOR_BUG_9701
changeset 15
b8a032363ba2
equal deleted inserted replaced
-1:000000000000 0:bef2f648167f
1 /* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4
5 #include "nsIInputStream.idl"
6 #include "nsIOutputStream.idl"
7
8 /**
9 * An input stream that reads ahead and keeps a buffer coming from another input
10 * stream so that fewer accesses to the underlying stream are necessary.
11 */
12 [scriptable, uuid(616f5b48-da09-11d3-8cda-0060b0fc14a3)]
13 interface nsIBufferedInputStream : nsIInputStream
14 {
15 /**
16 * @param fillFromStream - add buffering to this stream
17 * @param bufferSize - specifies the maximum buffer size
18 */
19 void init(in nsIInputStream fillFromStream,
20 in unsigned long bufferSize);
21 };
22
23 /**
24 * An output stream that stores up data to write out to another output stream
25 * and does the entire write only when the buffer is full, so that fewer writes
26 * to the underlying output stream are necessary.
27 */
28 [scriptable, uuid(6476378a-da09-11d3-8cda-0060b0fc14a3)]
29 interface nsIBufferedOutputStream : nsIOutputStream
30 {
31 /**
32 * @param sinkToStream - add buffering to this stream
33 * @param bufferSize - specifies the maximum buffer size
34 */
35 void init(in nsIOutputStream sinkToStream,
36 in unsigned long bufferSize);
37 };

mercurial