circut

Documentation

Index

• type Breaker
  • func New(resetDuration time.Duration, prober Prober) *Breaker
  • func (b *Breaker) FlagDown()
  • func (b *Breaker) FlagUp()
  • func (b *Breaker) IsUp() bool
• type Prober

Types

type Breaker

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

Breaker helps manage back-off in case of a resource checked by prober is unavailable.

func New

func New(resetDuration time.Duration, prober Prober) *Breaker

New creates a new circut breaker

func (*Breaker) FlagDown

func (b *Breaker) FlagDown()

FlagDown is used to indicate the resource is down.

func (*Breaker) FlagUp

func (b *Breaker) FlagUp()

FlagUp is used to reset the backoff.

func (*Breaker) IsUp

func (b *Breaker) IsUp() bool

IsUp returns true if resource is up, and will trigger a probe if it is due.

type Prober

type Prober interface {
	// Probe checks if service is up, if so it should call FlagUp
	Probe()
}

Prober represents abstraction to check if service is up. Types implementing this interface should also have access to the Breaker that will call Prober.Probe().