xpcom/io/nsIStorageStream.idl@6474c204b198 (annotated)
xpcom/io/nsIStorageStream.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- |
| michael@0 | 2 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | interface nsIInputStream; |
| michael@0 | 9 | interface nsIOutputStream; |
| michael@0 | 10 | |
| michael@0 | 11 | /** |
| michael@0 | 12 | * The nsIStorageStream interface maintains an internal data buffer that can be |
| michael@0 | 13 | * filled using a single output stream. One or more independent input streams |
| michael@0 | 14 | * can be created to read the data from the buffer non-destructively. |
| michael@0 | 15 | */ |
| michael@0 | 16 | |
| michael@0 | 17 | [scriptable, uuid(44a200fe-6c2b-4b41-b4e3-63e8c14e7c0d)] |
| michael@0 | 18 | interface nsIStorageStream : nsISupports |
| michael@0 | 19 | { |
| michael@0 | 20 | /** |
| michael@0 | 21 | * |
| michael@0 | 22 | * Initialize the stream, setting up the amount of space that will be |
| michael@0 | 23 | * allocated for the stream's backing-store. |
| michael@0 | 24 | * |
| michael@0 | 25 | * @param segmentSize |
| michael@0 | 26 | * Size of each segment. Must be a power of two. |
| michael@0 | 27 | * @param maxSize |
| michael@0 | 28 | * Maximum total size of this stream. length will always be less |
| michael@0 | 29 | * than or equal to this value. Passing UINT32_MAX is safe. |
| michael@0 | 30 | */ |
| michael@0 | 31 | void init(in uint32_t segmentSize, in uint32_t maxSize); |
| michael@0 | 32 | |
| michael@0 | 33 | /** |
| michael@0 | 34 | * Get a reference to the one and only output stream for this instance. |
| michael@0 | 35 | * The zero-based startPosition argument is used is used to set the initial |
| michael@0 | 36 | * write cursor position. The startPosition cannot be set larger than the |
| michael@0 | 37 | * current buffer length. Calling this method has the side-effect of |
| michael@0 | 38 | * truncating the internal buffer to startPosition bytes. |
| michael@0 | 39 | */ |
| michael@0 | 40 | nsIOutputStream getOutputStream(in int32_t startPosition); |
| michael@0 | 41 | |
| michael@0 | 42 | /** |
| michael@0 | 43 | * Create a new input stream to read data (written by the singleton output |
| michael@0 | 44 | * stream) from the internal buffer. Multiple, independent input streams |
| michael@0 | 45 | * can be created. |
| michael@0 | 46 | */ |
| michael@0 | 47 | nsIInputStream newInputStream(in int32_t startPosition); |
| michael@0 | 48 | |
| michael@0 | 49 | /** |
| michael@0 | 50 | * The length attribute indicates the total number of bytes stored in the |
| michael@0 | 51 | * nsIStorageStream internal buffer, regardless of any consumption by input |
| michael@0 | 52 | * streams. Assigning to the length field can be used to truncate the |
| michael@0 | 53 | * buffer data, but can not be used when either the instance's output |
| michael@0 | 54 | * stream is in use. |
| michael@0 | 55 | * |
| michael@0 | 56 | * @See #writeInProgress */ |
| michael@0 | 57 | attribute uint32_t length; |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * True, when output stream has not yet been Close'ed |
| michael@0 | 61 | */ |
| michael@0 | 62 | readonly attribute boolean writeInProgress; |
| michael@0 | 63 | }; |
| michael@0 | 64 | |
| michael@0 | 65 | %{C++ |
| michael@0 | 66 | // Factory method |
| michael@0 | 67 | nsresult |
| michael@0 | 68 | NS_NewStorageStream(uint32_t segmentSize, uint32_t maxSize, nsIStorageStream **result); |
| michael@0 | 69 | %} |
