Files
mozilla45esr/netwerk/base/nsIStreamTransportService.idl
roytam1 d97646cc37 import changes from tenfourfox:
- #632: M1424915 M1354233 M1324114 M1343008 M1236277(just backbugs) M1328955 (d87db7e16)
- #632: M1362498 M1397686 M136178 M1320252 M1355875 (82cb3b59e)
- #632: M241788 M1271955 M1249352(p1) + additional local optimizations (438bdb726)
- #632: M1249352 part 2 (2c61821e4)
- more hosts for adblock (c1a28532c)
- #632: M1249352(remaining) M1358297(backbugs) M1369317(pp1,3,4) M1426996 (1eab6170b)
- even more host (just one) for adblock (011118c38)
2020-11-27 09:40:25 +08:00

69 lines
2.8 KiB
Plaintext

/* 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.
*/
[builtinclass, 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);
};