Interface nsITransportEventSinkType

Hierarchy

Methods

AddRef QueryInterface Release onTransportStatus

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

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

onTransportStatus

  • Transport status notification.

    Parameters

    • aTransport: nsITransport

      the transport sending this status notification.

    • aStatus: number

      the transport status. See nsISocketTransport for socket specific status codes and more comments.

    • aProgress: number

      the amount of data either read or written depending on the value of the status code. this value is relative to aProgressMax.

    • aProgressMax: number

      the maximum amount of data that will be read or written. if unknown, -1 will be passed.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc