circuitbreaker

Documentation

Index

• Variables
• func Client(opts ...Option) middleware.Middleware
• type Option
  • func WithCircuitBreaker(genBreakerFunc func() circuitbreaker.CircuitBreaker) Option
  • func WithGroup(g *group.Group) Option

Variables

var ErrNotAllowed = errors.New(503, "CIRCUITBREAKER", "request failed due to circuit breaker triggered")

ErrNotAllowed is request failed due to circuit breaker triggered.

Functions

func Client

func Client(opts ...Option) middleware.Middleware

Client circuitbreaker middleware will return errBreakerTriggered when the circuit breaker is triggered and the request is rejected directly.

Types

type Option

type Option func(*options)

Option is circuit breaker option.

func WithCircuitBreaker

func WithCircuitBreaker(genBreakerFunc func() circuitbreaker.CircuitBreaker) Option

WithCircuitBreaker with circuit breaker genFunc.

func WithGroup

func WithGroup(g *group.Group) Option

WithGroup with circuit breaker group. NOTE: implements generics circuitbreaker.CircuitBreaker