Module mutiny.zero
Package mutiny.zero

Enum BackpressureStrategy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BackpressureStrategy>
    public enum BackpressureStrategy
extends java.lang.Enum<BackpressureStrategy>
    Define a Tube back-pressure management strategy.

    A Tube back-pressure management is required when an item is sent to a Tube while there are no outstanding items being requested.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BUFFER
      Buffer overflowing items until more items are being requested.
      DROP
      Drop items in case of a lack of outstanding requests.
      ERROR
      Signal a terminal IllegalStateException as soon as an item is being sent while there is no outstanding request.
      IGNORE
      Ignore back-pressure and still send items to the Tube consumer.
      LATEST
      Buffer overflowing items in a bounded buffer, but only keep the last values.
      UNBOUNDED_BUFFER
      Buffer overflowing items until more items are being requested.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BackpressureStrategy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BackpressureStrategy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • BUFFER

        public static final BackpressureStrategy BUFFER
        Buffer overflowing items until more items are being requested. The buffer is bounded, and an IllegalStateException will be thrown if it becomes full due to a lack of requests.

      • UNBOUNDED_BUFFER

        public static final BackpressureStrategy UNBOUNDED_BUFFER
        Buffer overflowing items until more items are being requested. The buffer is unbounded, so available memory is the limit, meaning that an OutOfMemoryError is possible if items are being pushed faster than they are being consumed.

      • DROP

        public static final BackpressureStrategy DROP
        Drop items in case of a lack of outstanding requests.

      • ERROR

        public static final BackpressureStrategy ERROR
        Signal a terminal IllegalStateException as soon as an item is being sent while there is no outstanding request.

      • IGNORE

        public static final BackpressureStrategy IGNORE
        Ignore back-pressure and still send items to the Tube consumer. This may result in errors in the subscriber(s) depending on what it means for back-pressure to be ignored.

      • LATEST

        public static final BackpressureStrategy LATEST
        Buffer overflowing items in a bounded buffer, but only keep the last values. This means that if the overflow buffer becomes full then the oldest item is discarded to make space for a new one.

    • Method Detail

      • values

        public static BackpressureStrategy[] 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 (BackpressureStrategy c : BackpressureStrategy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BackpressureStrategy valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null