Class Watchdog

  • All Implemented Interfaces:
    Closeable, AutoCloseable, Comparable<Watchdog>

    public class Watchdog
    extends Object
    implements Closeable, Comparable<Watchdog>
    A class that's a wrapper around a watchdog timer.

    When the timer expires, a message is printed to the console and an optional user-provided callback is invoked.

    The watchdog is initialized disabled, so the user needs to call enable() before use.

    • Constructor Detail

      • Watchdog

        public Watchdog​(double timeout,
                        Runnable callback)
        Watchdog constructor.
        Parameters:
        timeout - The watchdog's timeout in seconds with microsecond resolution.
        callback - This function is called when the timeout expires.
    • Method Detail

      • getTime

        public double getTime()
        Returns the time in seconds since the watchdog was last fed.
      • setTimeout

        public void setTimeout​(double timeout)
        Sets the watchdog's timeout.
        Parameters:
        timeout - The watchdog's timeout in seconds with microsecond resolution.
      • getTimeout

        public double getTimeout()
        Returns the watchdog's timeout in seconds.
      • isExpired

        public boolean isExpired()
        Returns true if the watchdog timer has expired.
      • addEpoch

        public void addEpoch​(String epochName)
        Adds time since last epoch to the list printed by printEpochs().

        Epochs are a way to partition the time elapsed so that when overruns occur, one can determine which parts of an operation consumed the most time.

        Parameters:
        epochName - The name to associate with the epoch.
      • printEpochs

        public void printEpochs()
        Prints list of epochs added so far and their times.
      • reset

        public void reset()
        Resets the watchdog timer.

        This also enables the timer if it was previously disabled.

      • enable

        public void enable()
        Enables the watchdog timer.
      • disable

        public void disable()
        Disables the watchdog timer.
      • suppressTimeoutMessage

        public void suppressTimeoutMessage​(boolean suppress)
        Enable or disable suppression of the generic timeout message.

        This may be desirable if the user-provided callback already prints a more specific message.

        Parameters:
        suppress - Whether to suppress generic timeout message.