netwerk/base/public/nsIBufferedStreams.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     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/. */
     5 #include "nsIInputStream.idl"
     6 #include "nsIOutputStream.idl"
     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 };
    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