breaker

Documentation

Index

• Variables
• func Do(name string, req func() error) error
• func DoWithAcceptable(name string, req func() error, acceptable Acceptable) error
• func DoWithFallback(name string, req func() error, fallback func(err error) error) error
• func DoWithFallbackAcceptable(name string, req func() error, fallback func(err error) error, ...) error
• func NoBreakFor(name string)
• type Acceptable
• type Breaker
  • func GetBreaker(name string) Breaker
  • func NewBreaker(opts ...Option) Breaker
• type Option
  • func WithName(name string) Option
• type Promise

Variables

var ErrServiceUnavailable = errors.New("circuit breaker is open")

ErrServiceUnavailable is returned when the CB state is open

Functions

func Do

func Do(name string, req func() error) error

func DoWithAcceptable

func DoWithAcceptable(name string, req func() error, acceptable Acceptable) error

func DoWithFallback

func DoWithFallback(name string, req func() error, fallback func(err error) error) error

func DoWithFallbackAcceptable

func DoWithFallbackAcceptable(name string, req func() error, fallback func(err error) error,
	acceptable Acceptable) error

func NoBreakFor

func NoBreakFor(name string)

Types

type Acceptable

type Acceptable func(err error) bool

type Breaker

type Breaker interface {
	// Name returns the name of the Breaker.
	Name() string

	// Allow checks if the request is allowed.
	// If allowed, a promise will be returned, the caller needs to call promise.Accept()
	// on success, or call promise.Reject() on failure.
	// If not allow, ErrServiceUnavailable will be returned.
	Allow() (Promise, error)

	// Do runs the given request if the Breaker accepts it.
	// Do returns an error instantly if the Breaker rejects the request.
	// If a panic occurs in the request, the Breaker handles it as an error
	// and causes the same panic again.
	Do(req func() error) error

	// DoWithAcceptable runs the given request if the Breaker accepts it.
	// DoWithAcceptable returns an error instantly if the Breaker rejects the request.
	// If a panic occurs in the request, the Breaker handles it as an error
	// and causes the same panic again.
	// acceptable checks if it's a successful call, even if the err is not nil.
	DoWithAcceptable(req func() error, acceptable Acceptable) error

	// DoWithFallback runs the given request if the Breaker accepts it.
	// DoWithFallback runs the fallback if the Breaker rejects the request.
	// If a panic occurs in the request, the Breaker handles it as an error
	// and causes the same panic again.
	DoWithFallback(req func() error, fallback func(err error) error) error

	// DoWithFallbackAcceptable runs the given request if the Breaker accepts it.
	// DoWithFallbackAcceptable runs the fallback if the Breaker rejects the request.
	// If a panic occurs in the request, the Breaker handles it as an error
	// and causes the same panic again.
	// acceptable checks if it's a successful call, even if the err is not nil.
	DoWithFallbackAcceptable(req func() error, fallback func(err error) error, acceptable Acceptable) error
}

func GetBreaker

func GetBreaker(name string) Breaker

func NewBreaker

func NewBreaker(opts ...Option) Breaker

type Option

type Option func(breaker *circuitBreaker)

func WithName

func WithName(name string) Option

type Promise

type Promise interface {
	Accept()
	Reject(reason string)
}