Interface nsIDashboardEventNotifierType

Hierarchy

Methods

AddRef QueryInterface Release addHost newMsgReceived newMsgSent removeHost

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

addHost

  • These methods are called to register a websocket event with the dashboard

    A host is identified by the (aHost, aSerial) pair. aHost: the host's name: example.com aSerial: a number that uniquely identifies the websocket

    aEncrypted: if the connection is encrypted aLength: the length of the message in bytes

    Parameters

    • aHost: string
    • aSerial: number
    • aEncrypted: boolean

    Returns void

newMsgReceived

  • Parameters

    • aHost: string
    • aSerial: number
    • aLength: number

    Returns void

newMsgSent

  • Parameters

    • aHost: string
    • aSerial: number
    • aLength: number

    Returns void

removeHost

  • Parameters

    • aHost: string
    • aSerial: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc