Interface nsIInputStreamChannelType

nsIInputStreamChannel

This interface provides methods to initialize an input stream channel. The input stream channel serves as a data pump for an input stream.

Hierarchy

Properties

baseURI: nsIURI

The base URI to be used for the channel. Used when the base URI cannot be inferred by other means, for example when this is a srcdoc channel.

contentStream: nsIInputStream

Get/set the content stream

This stream contains the data that will be pushed to the channel's stream listener. If the stream is non-blocking and supports the nsIAsyncInputStream interface, then the stream will be read directly. Otherwise, the stream will be read on a background thread.

This attribute must be set before the channel is opened, and it may only be set once.

Throws

NS_ERROR_IN_PROGRESS if the setter is called after the channel has been opened.

isSrcdocChannel: boolean

Returns true if srcdocData has been set within the channel.

srcdocData: string

Get/set the srcdoc data string. When the input stream channel is created to load a srcdoc iframe, this is set to hold the value of the srcdoc attribute.

This should be the same value used to create contentStream, but this is not checked.

Changing the value of this attribute will not otherwise affect the functionality of the channel or input stream.

Methods

  • 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

  • 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

  • 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

  • Sets the URI for this channel. This must be called before the channel is opened, and it may only be called once.

    Parameters

    • aURI: nsIURI

    Returns void

Generated using TypeDoc