Interface nsIStreamTransportServiceType

This service read/writes a stream on a background thread.

Note: instead of using this interface, probably you want to use NS_MakeAsyncNonBlockingInputStream.

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.

Hierarchy

Methods

AddRef InputAvailable QueryInterface Release createInputTransport

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

InputAvailable

  • Parameters

    • aStream: nsIInputStream
    • aCallback: nsIInputAvailableCallback

    Returns void

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

createInputTransport

  • CreateInputTransport

    Returns

    nsITransport instance.

    Parameters

    • aStream: nsIInputStream

      The input stream that will be read on a background thread. This stream must implement "blocking" stream semantics.

    • aCloseWhenDone: boolean

      Specify this flag to have the input stream closed once its contents have been completely read.

    Returns nsITransport

Settings

Member Visibility

Theme

Generated using TypeDoc