breaker

README

breaker

AFAIRE

Licence

MIT.

---

Copyright (c) 2021-2022 losyme

Documentation

Index

• type Breaker
  • func New(c *Config) *Breaker
  • func (b *Breaker) IsReady() bool
  • func (b *Breaker) State() State
  • func (b *Breaker) Update(success bool) State
• type Config
  • func DefaultConfig() *Config
• type OnStateChange
• type State

Types

type Breaker

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

func New

func New(c *Config) *Breaker

func (*Breaker) IsReady

func (b *Breaker) IsReady() bool

func (*Breaker) State

func (b *Breaker) State() State

func (*Breaker) Update

func (b *Breaker) Update(success bool) State

type Config

type Config struct {
	// Closed To Open
	CToO uint
	// Half-Open To Closed
	HOToC uint
	// Open To Half-Open
	OToHO time.Duration
	CbOSC OnStateChange
}

func DefaultConfig

func DefaultConfig() *Config

type OnStateChange

type OnStateChange func(from, to State)

type State

type State string

const (
	StateClosed   State = "closed"
	StateHalfOpen State = "half_open"
	StateOpen     State = "open"
)