breaker

package

v0.3.5 Latest Latest Go to latest Published: Jul 9, 2022 License: BSD-2-Clause Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var TimeoutError = errors.New("Circuit Breaker Timeout")

This section is empty.

type CircuitBreaker struct {
	Config
	sync.RWMutex

	OnChange func(EState)
	// contains filtered or unexported fields
}

func New(cfg Config) *CircuitBreaker

func (cb *CircuitBreaker) Metrics() Metrics

func (cb *CircuitBreaker) SetMetrics(metrics Metrics)

func (cb *CircuitBreaker) State() EState

func (cb *CircuitBreaker) Try(fn func() error, fallback func(err error) error) <-chan error

type Config struct {
	Timeout      time.Duration
	Maxfailures  int //consecutive failures
	ResetTimeout time.Duration
}

type EState int

const (
	CLOSE EState = iota
	OPEN
	HALFOPEN
)

func (e EState) String() string

type Metrics interface {
	IncSuccess()
	IncFailure()
}

type Stats struct {
	Successes uint32
	Fails     uint32
}