Module io.helidon.faulttolerance
Package io.helidon.faulttolerance

Interface Timeout

All Superinterfaces:
FtHandler, RuntimeType.Api<io.helidon.faulttolerance.TimeoutConfig>
@Contract public interface Timeout extends FtHandler, RuntimeType.Api<io.helidon.faulttolerance.TimeoutConfig>
Timeout attempts to terminate execution after defined duration of time.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static io.helidon.faulttolerance.TimeoutConfig.Builder
    builder()
    Create a new fluent API builder to customize a timeout.
    static Timeout
    create(io.helidon.faulttolerance.TimeoutConfig config)
    Create a timeout based on configuration.
    static Timeout
    create(Duration timeout)
    Create a Timeout with specified timeout.
    static Timeout
    create(Consumer<io.helidon.faulttolerance.TimeoutConfig.Builder> builderConsumer)
    Create a timeout with a possibility to customize its configuration.

    Methods inherited from interface io.helidon.faulttolerance.FtHandler

    invoke, name

    Methods inherited from interface io.helidon.builder.api.RuntimeType.Api

    prototype

  • Method Details

    • create

      static Timeout create(io.helidon.faulttolerance.TimeoutConfig config)
      Create a timeout based on configuration.
      Parameters:
      config - timeout configuration
      Returns:
      timeout handler

    • create

      static Timeout create(Consumer<io.helidon.faulttolerance.TimeoutConfig.Builder> builderConsumer)
      Create a timeout with a possibility to customize its configuration.
      Parameters:
      builderConsumer - consumer to customize configuration
      Returns:
      a new timeout

    • builder

      static io.helidon.faulttolerance.TimeoutConfig.Builder builder()
      Create a new fluent API builder to customize a timeout.
      Returns:
      a new timeout builder

    • create

      static Timeout create(Duration timeout)
      Create a Timeout with specified timeout.
      Parameters:
      timeout - duration of the timeout of operations handled by the new Timeout instance
      Returns:
      a new timeout