Interface nsIUrlClassifierUpdateObserverType

The nsIUrlClassifierUpdateObserver interface is implemented by clients streaming updates to the url-classifier (usually nsUrlClassifierStreamUpdater.

Hierarchy

Methods

AddRef QueryInterface Release streamFinished updateError updateSuccess updateUrlRequested

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

streamFinished

  • A stream update has completed.

    Parameters

    • status: number

      The state of the update process.

    • delay: number

      The amount of time the updater should wait to fetch the next URL in ms.

    Returns void

updateError

  • The update has encountered an error and should be cancelled

    Parameters

    • error: number

    Returns void

updateSuccess

  • The update has completed successfully.

    Parameters

    • requestedTimeout: number

      The number of seconds that the caller should wait before trying to update again.

    Returns void

updateUrlRequested

  • The update requested a new URL whose contents should be downloaded and sent to the classifier as a new stream.

    Parameters

    • url: string

      The url that was requested.

    • table: string

      The table name that this URL's contents will be associated with. This should be passed back to beginStream().

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc