Package org.openhab.core.config.discovery

Interface ScanListener

@NonNullByDefault public interface ScanListener
The ScanListener interface for receiving scan operation events.

A class that is interested in errors and termination of an active scan has to implement this interface.

Author:
Kai Kreuzer - Initial contribution
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    onErrorOccurred(@Nullable Exception exception)
    Invoked synchronously when the according scan has caused an error or has been aborted.
    void
    onFinished()
    Invoked synchronously when the according scan has finished.

  • Method Details

    • onFinished

      void onFinished()
      Invoked synchronously when the according scan has finished.

      This signal is sent latest when the defined timeout for the scan has been reached.

    • onErrorOccurred

      void onErrorOccurred(@Nullable Exception exception)
      Invoked synchronously when the according scan has caused an error or has been aborted.
      Parameters:
      exception - the error which occurred (could be null)