circuit

Documentation

Index

• type Breaker
  • func NewBreaker(threshold int, timeout time.Duration) *Breaker
  • func (b *Breaker) Allow() bool
  • func (b *Breaker) Failures() int
  • func (b *Breaker) RecordFailure()
  • func (b *Breaker) RecordSuccess()
  • func (b *Breaker) Reset()
  • func (b *Breaker) State() State
• type State
  • func (s State) String() string

Types

type Breaker

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

Breaker implements the circuit breaker pattern

func NewBreaker

func NewBreaker(threshold int, timeout time.Duration) *Breaker

NewBreaker creates a new circuit breaker threshold: number of consecutive failures before opening the circuit timeout: duration to wait before transitioning from open to half-open

func (*Breaker) Allow

func (b *Breaker) Allow() bool

Allow returns true if the request is allowed to proceed

func (*Breaker) Failures

func (b *Breaker) Failures() int

Failures returns the current failure count

func (*Breaker) RecordFailure

func (b *Breaker) RecordFailure()

RecordFailure records a failed operation May transition to open state if threshold is exceeded

func (*Breaker) RecordSuccess

func (b *Breaker) RecordSuccess()

RecordSuccess records a successful operation Resets the circuit breaker to closed state

func (*Breaker) Reset

func (b *Breaker) Reset()

Reset resets the circuit breaker to closed state

func (*Breaker) State

func (b *Breaker) State() State

State returns the current state of the circuit breaker

type State

type State int

State represents the circuit breaker state

const (
	StateClosed   State = iota // Normal operation
	StateOpen                  // Circuit breaker is open, requests fail fast
	StateHalfOpen              // Testing if service has recovered
)

func (State) String

func (s State) String() string