circuitbreaker

Documentation

Overview

Package circuitbreaker provides a circuit breaker pattern implementation.

Index

• type Action
• type CircuitBreaker
  • func New(name string, s Setting) (*CircuitBreaker, error)
  • func (cb *CircuitBreaker) Execute(act Action) (interface{}, error)
• type OpenError
  • func (oe OpenError) Error() string
• type Setting

Types

type Action

type Action func() (interface{}, error)

Action function to execute in circuit breaker.

type CircuitBreaker

type CircuitBreaker struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

CircuitBreaker implementation.

func New

func New(name string, s Setting) (*CircuitBreaker, error)

New returns a new instance.

func (*CircuitBreaker) Execute

func (cb *CircuitBreaker) Execute(act Action) (interface{}, error)

Execute the provided action.

type OpenError

type OpenError struct{}

OpenError definition for the open state.

func (OpenError) Error

func (oe OpenError) Error() string

type Setting

type Setting struct {
	// FailureThreshold for the circuit to open.
	FailureThreshold uint
	// RetryTimeout after which we set the state to half-open and allow a retry.
	RetryTimeout time.Duration
	// RetrySuccessThreshold which returns the state to open.
	RetrySuccessThreshold uint
	// MaxRetryExecutionThreshold which defines how many tries are allowed when the status is half-open.
	MaxRetryExecutionThreshold uint
}

Setting definition.