blob: cd39f9cba3c3bcc6f5a5dfad08d449ad71acccd0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/* 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 "nsISupports.idl"
interface nsITransport;
interface nsIInputStream;
interface nsIOutputStream;
/**
* This service read/writes a stream on a background thread.
*
* Use this service to transform any blocking stream (e.g., file stream)
* into a fully asynchronous stream that can be read/written without
* blocking the main thread.
*/
[scriptable, uuid(5e0adf7d-9785-45c3-a193-04f25a75da8f)]
interface nsIStreamTransportService : nsISupports
{
/**
* CreateInputTransport
*
* @param aStream
* The input stream that will be read on a background thread.
* This stream must implement "blocking" stream semantics.
* @param aStartOffset
* The input stream will be read starting from this offset. Pass
* -1 to read from the current stream offset. NOTE: this parameter
* is ignored if the stream does not support nsISeekableStream.
* @param aReadLimit
* This parameter limits the number of bytes that will be read from
* the input stream. Pass -1 to read everything.
* @param aCloseWhenDone
* Specify this flag to have the input stream closed once its
* contents have been completely read.
*
* @return nsITransport instance.
*/
nsITransport createInputTransport(in nsIInputStream aStream,
in long long aStartOffset,
in long long aReadLimit,
in boolean aCloseWhenDone);
/**
* CreateOutputTransport
*
* @param aStream
* The output stream that will be written to on a background thread.
* This stream must implement "blocking" stream semantics.
* @param aStartOffset
* The output stream will be written starting at this offset. Pass
* -1 to write to the current stream offset. NOTE: this parameter
* is ignored if the stream does not support nsISeekableStream.
* @param aWriteLimit
* This parameter limits the number of bytes that will be written to
* the output stream. Pass -1 for unlimited writing.
* @param aCloseWhenDone
* Specify this flag to have the output stream closed once its
* contents have been completely written.
*
* @return nsITransport instance.
*/
nsITransport createOutputTransport(in nsIOutputStream aStream,
in long long aStartOffset,
in long long aWriteLimit,
in boolean aCloseWhenDone);
};
|
