netwerk/base/nsIBufferedStreams.idl
author Andrew Halberstadt <ahalberstadt@mozilla.com>
Thu, 25 May 2017 11:48:03 -0400
changeset 410946 ff64a7889c1fac56d48205fc2fad4eb5aa481a73
parent 406275 11b8084a6cea906d8b6f22614223973177430446
permissions -rw-r--r--
Bug 1346025 - Move vendored python modules from /python to /third_party/python, r=ted This commit is a simple 'hg mv' and does not contain any file modifications. *** Bug 1346025 - Split vendored modules in python/moz.build to third_party/python/moz.build, r=ted *** Bug 1346025 - Update references to moved python modules, r=ted MozReview-Commit-ID: A12RnIFtXju

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsIInputStream.idl"
#include "nsIOutputStream.idl"

/**
 * An input stream that reads ahead and keeps a buffer coming from another input
 * stream so that fewer accesses to the underlying stream are necessary.
 */
[scriptable, uuid(616f5b48-da09-11d3-8cda-0060b0fc14a3)]
interface nsIBufferedInputStream : nsIInputStream
{
    /**
     * @param fillFromStream - add buffering to this stream
     * @param bufferSize     - specifies the maximum buffer size
     */
    void init(in nsIInputStream fillFromStream,
              in unsigned long bufferSize);

    /**
     * Get the wrapped data stream
     */
    readonly attribute nsIInputStream data;
};

/**
 * An output stream that stores up data to write out to another output stream
 * and does the entire write only when the buffer is full, so that fewer writes
 * to the underlying output stream are necessary.
 */
[scriptable, uuid(6476378a-da09-11d3-8cda-0060b0fc14a3)]
interface nsIBufferedOutputStream : nsIOutputStream
{
    /**
     * @param sinkToStream - add buffering to this stream
     * @param bufferSize   - specifies the maximum buffer size
     */
    void init(in nsIOutputStream sinkToStream,
              in unsigned long bufferSize);

    /**
     * Get the wrapped data stream
     */
    readonly attribute nsIOutputStream data;
};