Module org.refcodes.controlflow
Package org.refcodes.controlflow

Class RetryTimeout

  • All Implemented Interfaces:
    Retryable, org.refcodes.mixin.Abortable, org.refcodes.mixin.ReadTimeoutInMsAccessor, org.refcodes.mixin.Restartable
    public class RetryTimeout
extends Object
implements Retryable, org.refcodes.mixin.ReadTimeoutInMsAccessor
    The RetryTimeout can be used in loops to test whether a timeout has been reached, if the timeout has not been reached, then a given period of time (delay) is waited. In case no more timeout is "left" the business logic may act accordingly such as throwing an exception.

    The actual timeout being waited is the effective time elapsed from the first call to nextRetry() till the last call to nextRetry(). Any delay inside the iteration loop is not added up to the delay.

    • Constructor Detail

      • RetryTimeout

        public RetryTimeout​(long aTimeoutInMs,
                    long aRetryDelayInMs)
        Constructs the RetryTimeout with the given timeout and the given retry delay. The retry number is round about: ------------------------------------------------------------------------- "aTimeoutInMs / aRetryDelayInMs" ------------------------------------------------------------------------- CAUTION: The above mentioned is not necessarily so, in case your business logic inside the loop iterations is slow, then less retries fit in the given timeout.
        Parameters:
        aTimeoutInMs - The total time in milliseconds all iterations together will delay.
        aRetryDelayInMs - The delay before each retry to wait in milliseconds.

      • RetryTimeout

        public RetryTimeout​(long aTimeoutInMs,
                    int aRetryLoops)
        Constructs the RetryTimeout with the given timeout and the given number of retry loops. The retry delay is round about: ------------------------------------------------------------------------- "aTimeoutInMs / aRetryLoops" ------------------------------------------------------------------------- CAUTION: The above mentioned is not necessarily so, in case your business logic inside the loop iterations is slow, then less retries fit in the given timeout.
        Parameters:
        aTimeoutInMs - The total time in milliseconds all iterations together will delay.
        aRetryLoops - The number of retries, each retry delay before each retry to wait in milliseconds is about the timeout divided by the retry number.

    • Method Detail

      • nextRetry

        public boolean nextRetry()
        Tests whether a next retry is possible. In case this is the case, then the thread is delayed by the configured (implementation specific) delay time or until the provided monitor is notified via Object.notify() or Object.notifyAll(). Similar to the nextRetry() with the difference of accepting a dedicated monitor which is used for aborting the dellay.
        Specified by:
        nextRetry in interface Retryable
        Returns:
        True in case there is a next retry as of hasNextRetry().

      • nextRetry

        public boolean nextRetry​(Object aMonitor)
        Tests whether a next retry is possible. In case this is the case, then the thread is delayed by the configured (implementation specific) delay time or until the provided monitor is notified via Object.notify() or Object.notifyAll(). Similar to the nextRetry() with the difference of accepting a dedicated monitor which is used for aborting the dellay.
        Parameters:
        aMonitor - the monitor
        Returns:
        True in case there is a next retry as of hasNextRetry().

      • hasNextRetry

        public boolean hasNextRetry()
        Returns true in case not all retires have been used up.
        Specified by:
        hasNextRetry in interface Retryable
        Returns:
        True in case there are retries left true in case all retries elapsed.

      • getRetryCount

        public int getRetryCount()
        The current state regarding the retires. It specifies at which retry we currently are.
        Specified by:
        getRetryCount in interface Retryable
        Returns:
        The number of retries used up so far.

      • abort

        public void abort()
        Specified by:
        abort in interface org.refcodes.mixin.Abortable

      • restart

        public void restart()
        Specified by:
        restart in interface org.refcodes.mixin.Restartable

      • getReadTimeoutInMs

        public long getReadTimeoutInMs()
        Returns the timeout altogether the RetryTimeout is waiting while iterating through the RetryTimeout via hasNextRetry() and nextRetry(). The actual timeout being waited is the effective time elapsed from the first call to nextRetry() till the last call to nextRetry(). Any delay inside the iteration loop is not added up to the delay.
        Specified by:
        getReadTimeoutInMs in interface org.refcodes.mixin.ReadTimeoutInMsAccessor
        Returns:
        The timeout in milliseconds.

      • getRetryDelayInMs

        public long getRetryDelayInMs()
        Returns retry to wait in milliseconds upon calling nextRetry()).
        Returns:
        The delay being set in milliseconds.