breaker

Documentation

Index

• Variables
• type Breaker
  • func New(errorThreshold int, timeout time.Duration) *Breaker
  • func (b *Breaker) Error()
  • func (b *Breaker) Run(fn func()) error

Variables

var ErrBreakerOpen = errors.New("breaker: circuit breaker is open")

ErrBreakerOpen is the error returned from Run() when the breaker is open.

Types

type Breaker

type Breaker struct {
	// contains filtered or unexported fields
}

Breaker implements the circuit-breaker pattern.

func New

func New(errorThreshold int, timeout time.Duration) *Breaker

New creates a new Breaker.

func (*Breaker) Error

func (b *Breaker) Error()

Error registers an error with the circuit-breaker, potentially opening the breaker.

func (*Breaker) Run

func (b *Breaker) Run(fn func()) error

Run will run the given function or return ErrBreakerOpen immediately if the circuit-breaker is open.