Package io.smallrye.faulttolerance.api

Interface Guard.Builder.TimeoutBuilder

Enclosing interface:
Guard.Builder
public static interface Guard.Builder.TimeoutBuilder
Configures a timeout.
See Also:
  • @Timeout

  • Method Details

    • duration

      Guard.Builder.TimeoutBuilder duration(long value, ChronoUnit unit)
      Sets the timeout duration. Defaults to 1 second.
      Parameters:
      value - the timeout length, must be >= 0
      unit - the timeout unit, must not be null
      Returns:
      this timeout builder
      See Also:
      • @Timeout.value
      • @Timeout.unit

    • onTimeout

      Guard.Builder.TimeoutBuilder onTimeout(Runnable callback)
      Sets a callback that will be invoked when an invocation times out.

      The callback must be fast and non-blocking and must not throw an exception.

      Parameters:
      callback - the timeout callback, must not be null
      Returns:
      this timeout builder

    • onFinished

      Guard.Builder.TimeoutBuilder onFinished(Runnable callback)
      Sets a callback that will be invoked when an invocation finishes before the timeout.

      The callback must be fast and non-blocking and must not throw an exception.

      Parameters:
      callback - the finished callback, must not be null
      Returns:
      this timeout builder

    • done

      Guard.Builder done()
      Returns the original fault tolerance builder.
      Returns:
      the original fault tolerance builder

    • with

      default Guard.Builder.TimeoutBuilder with(Consumer<Guard.Builder.TimeoutBuilder> consumer)