circuit

Documentation

Index

• Variables
• type Breaker
  • func NewBreaker(tick time.Duration, threshold uint64) *Breaker
  • func (b *Breaker) Do(task func() (*http.Response, error)) (*http.Response, error)
  • func (b *Breaker) Stop()

Variables

var ErrCircuitBreakerOpen error = errors.New("circuit breaker is open")

ErrCircuitBreakerOpen is the error that the breaker returns when it is open

Types

type Breaker

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

Breaker is a type that implements the circuit breaker pattern

func NewBreaker

func NewBreaker(tick time.Duration, threshold uint64) *Breaker

NewBreaker returns a new Breaker with the specified tick duration and failures threshold number

func (*Breaker) Do

func (b *Breaker) Do(task func() (*http.Response, error)) (*http.Response, error)

Do checks the state of the circuit breaker and executes the task accordingly

func (*Breaker) Stop

func (b *Breaker) Stop()

Stop will stop the supporting goroutine for the breaker