breaker

README

breaker

TODO

---

Copyright (c) 2022 Archivage Numérique

Documentation

Overview

Package breaker TODO

Index

• type Breaker
  • func New(cfg *Config) *Breaker
  • func (b *Breaker) State() State
  • func (b *Breaker) Update(success bool) State
  • func (b *Breaker) Usable() bool
• type Config
• type OnStateChangeFunc
• type State

Types

type Breaker

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

func New

func New(cfg *Config) *Breaker

func (*Breaker) State

func (b *Breaker) State() State

func (*Breaker) Update

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

func (*Breaker) Usable

func (b *Breaker) Usable() bool

type Config

type Config struct {
	Name              string        `dm:"name"`
	CloseToOpen       uint          `dm:"close_to_open"`
	HalfOpenToClose   uint          `dm:"half_open_to_close"`
	OpenToHalfOpen    time.Duration `dm:"open_to_half_open"`
	OnStateChangeFunc OnStateChangeFunc
}

type OnStateChangeFunc

type OnStateChangeFunc func(name string, to, from State)

type State

type State string

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