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

Interface Bulkhead

All Superinterfaces:
FtHandler
public interface Bulkhead extends FtHandler
Bulkhead protects a resource that cannot serve unlimited parallel requests.

When the limit of parallel execution is reached, requests are enqueued until the queue length is reached. Once both the limit and queue are full, additional attempts to invoke will end with a failed response with BulkheadException.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Bulkhead.Builder
    Fluent API builder for Bulkhead.
    static interface 
    Bulkhead.QueueListener
    A Bulkhead listener for queueing operations.
    static interface 
    Bulkhead.Stats
    Provides statistics during the lifetime of a bulkhead, such as concurrent executions, accepted/rejected calls and queue size.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Bulkhead.Builder
    builder()
    A new builder for Bulkhead.
    boolean
    cancelSupplier(Supplier<?> supplier)
    Can be used to cancel a supplier while queued.
    Bulkhead.Stats
    stats()
    Provides access to internal stats for this bulkhead.

    Methods inherited from interface io.helidon.nima.faulttolerance.FtHandler

    invoke, name

  • Method Details

    • builder

      static Bulkhead.Builder builder()
      A new builder for Bulkhead.
      Returns:
      a new builder

    • stats

      Bulkhead.Stats stats()
      Provides access to internal stats for this bulkhead.
      Returns:
      internal stats.

    • cancelSupplier

      boolean cancelSupplier(Supplier<?> supplier)
      Can be used to cancel a supplier while queued.
      Parameters:
      supplier - the supplier
      Returns:
      outcome of cancellation