circuit

Documentation

Overview

package circuit is an alternative of the classic circuitbreaker.

Index

• Variables
• type Breaker
  • func New(client *redis.Client, channel string, opts *Options) (*Breaker, func())
  • func (b *Breaker) Do(ctx context.Context, fn func() error) error
  • func (b *Breaker) Status() Status
• type Options
  • func NewOptions() *Options
• type Status
  • func NewStatus(status string) Status
  • func (s Status) String() string

Variables

var (
	ErrUnavailable = errors.New("circuit: unavailable")
	ErrForcedOpen  = errors.New("circuit: forced open")
)

Types

type Breaker

type Breaker struct {

	// Options.
	FailureCount  func(error) int
	Now           func() time.Time
	SlowCallCount func(time.Duration) int
	// contains filtered or unexported fields
}

func New

func New(client *redis.Client, channel string, opts *Options) (*Breaker, func())

func (*Breaker) Do

func (b *Breaker) Do(ctx context.Context, fn func() error) error

func (*Breaker) Status

func (b *Breaker) Status() Status

type Options

type Options struct {
	BreakDuration     time.Duration
	FailureRatio      float64
	FailureThreshold  int
	HeartbeatDuration time.Duration
	SamplingDuration  time.Duration
	SuccessThreshold  int
}

func NewOptions

func NewOptions() *Options

type Status

type Status int

const (
	Closed Status = iota
	Disabled
	HalfOpen
	ForcedOpen
	Open
)

func NewStatus

func NewStatus(status string) Status

func (Status) String

func (s Status) String() string