circuitbreaker

README

circuitbreaker

Documentation

Index

• Variables
• func NewCircuitBreaker(conf *Config) *defaultCircuitBreaker
• func NewSettings() *defaultSettings
• type CircuitBreaker
• type Config
• type Event
  • func (e Event) String() string
• type Opt
• type Runnable
• type Settings
• type State
  • func (s State) String() string

Variables

var DefaultOpts defaultOpts

var (
	OpenStateErr = errors.New("Circuit breaker is opened ")
)

Functions

func NewCircuitBreaker

func NewCircuitBreaker(conf *Config) *defaultCircuitBreaker

func NewSettings

func NewSettings() *defaultSettings

Types

type CircuitBreaker

type CircuitBreaker interface {
	GetState() State

	Run(runnable Runnable) error

	Go(runnable, fallback Runnable) error

	io.Closer
}

type Config

type Config struct {
	Interval time.Duration

	Counter counter.Counter

	Settings Settings
}

type Event

type Event int8

const (
	EventTriggered Event = iota
	EventFailure
	EventSuccess
	EventExpired
)

func (Event) String

func (e Event) String() string

type Opt

type Opt func(Settings)

type Runnable

type Runnable func() error

type Settings

type Settings interface {
	Set(key string, value interface{}) Settings
}

type State

type State int32

const (
	StateClosed   State = 0
	StateOpen     State = 1
	StateHalfOpen State = 2
)

func (State) String

func (s State) String() string