Package io.vertx.mutiny.circuitbreaker

Class FailurePolicy<T>

java.lang.Object
io.vertx.mutiny.circuitbreaker.FailurePolicy<T>
All Implemented Interfaces:
MutinyDelegate
public class FailurePolicy<T> extends Object implements MutinyDelegate
A failure policy for the CircuitBreaker.

The default policy is to consider an asynchronous result as a failure if AsyncResult#failed() returns true. Nevertheless, sometimes this is not good enough. For example, an HTTP Client could return a response, but with an unexpected status code.

In this case, a custom failure policy can be configured with CircuitBreaker.failurePolicy(FailurePolicy).

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

See Also:
  • FailurePolicy

  • Field Details

  • Constructor Details

    • FailurePolicy

      public FailurePolicy(io.vertx.circuitbreaker.FailurePolicy<T> delegate)
      Create a new instance of FailurePolicy delegating to the given (non-null) instance of FailurePolicy.

    • FailurePolicy

      public FailurePolicy(io.vertx.circuitbreaker.FailurePolicy<T> delegate, TypeArg<T> typeArg_0)

    • FailurePolicy

      public FailurePolicy(Object delegate, TypeArg<T> typeArg_0)

  • Method Details

    • getDelegate

      public io.vertx.circuitbreaker.FailurePolicy<T> getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • defaultPolicy

      public static <U> FailurePolicy<U> defaultPolicy()
      The default policy, which considers an asynchronous result as a failure if AsyncResult#failed() returns true.

    • test

      public boolean test(io.smallrye.mutiny.Uni<T> future)
      Invoked by the CircuitBreaker when an operation completes.
      Parameters:
      future - a completed future
      Returns:
      true if the asynchronous result should be considered as a failure, false otherwise

    • newInstance

      public static <T> FailurePolicy<T> newInstance(io.vertx.circuitbreaker.FailurePolicy<T> delegate)
      Creates a new instance of the FailurePolicy.

    • newInstance

      public static <T> FailurePolicy<T> newInstance(io.vertx.circuitbreaker.FailurePolicy<T> delegate, TypeArg<T> typeArg_0)
      Creates a new instance of the FailurePolicy.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object