Interface ITimerEngine

  • public interface ITimerEngine
    The timer engine handles timeouts and scheduled events.

    It can be used to register a timeout for a task that runs in a thread. When timeout is reached, the method ITimeoutListener.onTimeout() is called from another thread, informing the running thread of this timeout. It is up to the running thread to take appropriate action.

    It can also handle a scheduled periodic event notification that also runs in a thread.

    Christopher Mindus
    • Method Detail

      • registerTimeout

        ITimeoutTask registerTimeout​(long timeout,
                                     java.lang.String description,
                                     ITimeoutListener listener)
        Registers a new timeout for processing.
        timeout - The timeout in milliseconds, -1 for indefinite.
        description - The description of the timeout operation, null for none.
        listener - The listener for timeout notification.
        java.lang.NullPointerException - If the listener is null.
        java.lang.IllegalStateException - If the engine has been disposed of.
      • dispose

        void dispose()
        Disposes of the engine and disposes of all pending scheduled timers and timeouts.
      • isDisposed

        boolean isDisposed()
        Checks if engine is disposed or not.
        true if disposed, false otherwise.