Package com.hivemq.extension.sdk.api.async

Enum Async.Status

  • All Implemented Interfaces:
    Serializable, Comparable<Async.Status>
    Enclosing interface:
    Async<T>
    public static enum Async.Status
extends Enum<Async.Status>
    Information about the runtime status of an async option.

    The runtime state of an async option has the following transitions. 

     +
 |
 | AsyncOutput.async(Duration d)
 |
 v
 +---------+                +------+
 |         | Async.resume() |      |
 | RUNNING +--------------->+ DONE |
 |         |                |      |
 +---------+                +------+
 |
 | after Duration d
 |
 v
 +----------+
 |          |
 | CANCELED |
 |          |
 +----------+
    Since:
    4.0.0, CE 2019.1

    • Enum Constant Detail

      • RUNNING

        public static final Async.Status RUNNING
        The async operation is still ongoing.
        Since:
        4.0.0, CE 2019.1

      • CANCELED

        public static final Async.Status CANCELED
        The duration for the async operation has timed out.
        Since:
        4.0.0, CE 2019.1

      • DONE

        public static final Async.Status DONE
        The async operation completed before the timeout, with calling Async.resume().
        Since:
        4.0.0, CE 2019.1

    • Method Detail

      • values

        public static Async.Status[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Async.Status c : Async.Status.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Async.Status valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null