CircuitBreaker | @vertx/circuit-breaker

An implementation of the circuit breaker pattern for Vert.x

Hierarchy

CircuitBreaker

Index

Methods

close

close(): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:43
Closes the circuit breaker. It stops sending events on its state on the event bus. This method is not related to the close state of the circuit breaker. To set the circuit breaker in the close state, use {@link CircuitBreaker#reset}.

Returns CircuitBreaker

closeHandler

closeHandler(handler: ((res: void) => void) | Handler<void>): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:58
Sets a invoked when the circuit breaker state switches to close.

Parameters
- handler: ((res: void) => void) | Handler<void>
Returns CircuitBreaker

execute

execute<T>(command: ((res: Promise<T>) => void) | Handler<Promise<T>>): PromiseLike<T>
execute<T>(command: ((res: Promise<T>) => void) | Handler<Promise<T>>, handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>): void

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:73
Same as {@link CircuitBreaker#executeWithFallback} but using the circuit breaker default fallback.

Type parameters
- T
Parameters
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
Returns PromiseLike<T>
- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:78
Same as {@link CircuitBreaker#executeWithFallback} but using the circuit breaker default fallback.

Type parameters
- T
Parameters
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
- handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>
Returns void

executeAndReport

executeAndReport<T>(resultPromise: Promise<T>, command: ((res: Promise<T>) => void) | Handler<Promise<T>>): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:84
Same as {@link CircuitBreaker#executeAndReportWithFallback} but using the circuit breaker default fallback.

Type parameters
- T
Parameters
- resultPromise: Promise<T>
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
Returns CircuitBreaker

executeAndReportWithFallback

executeAndReportWithFallback<T>(resultPromise: Promise<T>, command: ((res: Promise<T>) => void) | Handler<Promise<T>>, fallback: (arg: Throwable) => T): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:101
Executes the given operation with the circuit breaker control. The operation is generally calling an external system. The operation receives a object as parameter and must call when the operation has terminated successfully. The operation must also call in case of failure.

The operation is not invoked if the circuit breaker is open, and the given fallback is called immediately. The circuit breaker also monitor the completion of the operation before a configure timeout. The operation is considered as failed if it does not terminate in time.
Unlike {@link CircuitBreaker#executeWithFallback}, this method does return a object, but let the caller pass a object on which the result is reported. If the fallback is called, the future is successfully completed with the value returned by the fallback function. If the fallback throws an exception, the future is marked as failed.

Type parameters
- T
Parameters
- resultPromise: Promise<T>
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
- fallback: (arg: Throwable) => T
  - - (arg: Throwable): T
    - Parameters
      - arg: Throwable
      Returns T
Returns CircuitBreaker

executeWithFallback

executeWithFallback<T>(command: ((res: Promise<T>) => void) | Handler<Promise<T>>, fallback: (arg: Throwable) => T): PromiseLike<T>
executeWithFallback<T>(command: ((res: Promise<T>) => void) | Handler<Promise<T>>, fallback: (arg: Throwable) => T, handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>): void

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:63
Same as {@link CircuitBreaker#executeWithFallback} but using a callback.

Type parameters
- T
Parameters
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
- fallback: (arg: Throwable) => T
  - - (arg: Throwable): T
    - Parameters
      - arg: Throwable
      Returns T
Returns PromiseLike<T>
- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:68
Same as {@link CircuitBreaker#executeWithFallback} but using a callback.

Type parameters
- T
Parameters
- command: ((res: Promise<T>) => void) | Handler<Promise<T>>
- fallback: (arg: Throwable) => T
  - - (arg: Throwable): T
    - Parameters
      - arg: Throwable
      Returns T
- handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>
Returns void

failureCount

failureCount(): number

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:127
Returns number

fallback

fallback<T>(handler: (arg: Throwable) => T): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:109
Sets a default invoked when the bridge is open to handle the "request", or on failure if CircuitBreakerOptions is enabled.

The function gets the exception as parameter and returns the fallback result.

Type parameters
- T
Parameters
- handler: (arg: Throwable) => T
  - - (arg: Throwable): T
    - Parameters
      - arg: Throwable
      Returns T
Returns CircuitBreaker

halfOpenHandler

halfOpenHandler(handler: ((res: void) => void) | Handler<void>): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:53
Sets a invoked when the circuit breaker state switches to half-open.

Parameters
- handler: ((res: void) => void) | Handler<void>
Returns CircuitBreaker

name

name(): string

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:131
Returns string

open

open(): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:119
Explicitly opens the circuit.

Returns CircuitBreaker

openHandler

openHandler(handler: ((res: void) => void) | Handler<void>): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:48
Sets a invoked when the circuit breaker state switches to open.

Parameters
- handler: ((res: void) => void) | Handler<void>
Returns CircuitBreaker

reset

reset(): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:114
Resets the circuit breaker state (number of failure set to 0 and state set to closed).

Returns CircuitBreaker

retryPolicy

retryPolicy(retryPolicy: (arg: number) => number): CircuitBreaker
retryPolicy(retryPolicy: RetryPolicy): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:135
Parameters
- retryPolicy: (arg: number) => number
  - - (arg: number): number
    - Parameters
      - arg: number
      Returns number
Returns CircuitBreaker
- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:140
Set a RetryPolicy which computes a delay before retry execution.

Parameters
- retryPolicy: RetryPolicy
Returns CircuitBreaker

state

state(): CircuitBreakerState

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:123
Returns CircuitBreakerState

Static create

create(name: string, vertx: Vertx, options: CircuitBreakerOptions): CircuitBreaker
create(name: string, vertx: Vertx): CircuitBreaker

- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:31
Creates a new instance of CircuitBreaker.

Parameters
- name: string
- vertx: Vertx
- options: CircuitBreakerOptions
Returns CircuitBreaker
- Defined in io.vertx/vertx-circuit-breaker/target/npm/index.d.ts:36
Creates a new instance of CircuitBreaker, with default options.

Parameters
- name: string
- vertx: Vertx
Returns CircuitBreaker

Hierarchy

Index

Methods

Methods

close

Returns CircuitBreaker

closeHandler

Parameters

handler: ((res: void) => void) | Handler<void>

Returns CircuitBreaker

execute

Type parameters

T

Parameters

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

Returns PromiseLike<T>

Type parameters

T

Parameters

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>

Returns void

executeAndReport

Type parameters

T

Parameters

resultPromise: Promise<T>

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

Returns CircuitBreaker

executeAndReportWithFallback

Type parameters

T

Parameters

resultPromise: Promise<T>

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

fallback: (arg: Throwable) => T

Parameters

arg: Throwable

Returns T

Returns CircuitBreaker

executeWithFallback

Type parameters

T

Parameters

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

fallback: (arg: Throwable) => T

Parameters

arg: Throwable

Returns T

Returns PromiseLike<T>

Type parameters

T

Parameters

command: ((res: Promise<T>) => void) | Handler<Promise<T>>

fallback: (arg: Throwable) => T

Parameters

arg: Throwable

Returns T

handler: ((res: AsyncResult<T>) => void) | Handler<AsyncResult<T>>

Returns void

failureCount

Returns number

fallback

Type parameters

T

Parameters

handler: (arg: Throwable) => T

Parameters

arg: Throwable

Returns T

Returns CircuitBreaker

halfOpenHandler

Parameters

handler: ((res: void) => void) | Handler<void>

Returns CircuitBreaker

name

Returns string

open

Returns CircuitBreaker

openHandler