circuitbreaker

Documentation

Index

• func CircuitExists(circuitName string) bool
• func IsCircuitOpen(circuitName string) bool
• type CircuitBreaker
  • func NewCircuitBreaker(config Config) *CircuitBreaker
  • func (cb *CircuitBreaker) Execute(cmd *Command) CommandResult
  • func (c *CircuitBreaker) SetOverrideCircuitNameHandler(f func(string) string)
• type Command
  • func NewCommand(ctx context.Context, functors []*Functor) *Command
  • func (cmd *Command) Add(ftor *Functor)
  • func (cmd *Command) Cancel()
  • func (cmd *Command) IsEmpty() bool
• type CommandResult
  • func (cr CommandResult) Error() error
  • func (cr CommandResult) Result() []any
• type Config
• type FallbackFunc
• type Functor
  • func NewFunctor(exec FallbackFunc, circuitName string) *Functor

Functions

func CircuitExists

func CircuitExists(circuitName string) bool

func IsCircuitOpen

func IsCircuitOpen(circuitName string) bool

Expects a circuit to exist because a new circuit is always closed. Call CircuitExists to check if a circuit exists.

Types

type CircuitBreaker

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

func NewCircuitBreaker

func NewCircuitBreaker(config Config) *CircuitBreaker

func (*CircuitBreaker) Execute

func (cb *CircuitBreaker) Execute(cmd *Command) CommandResult

Executes the command in its circuit if set. If the command's circuit is not configured, the circuit of the CircuitBreaker is used. This is a blocking function.

func (*CircuitBreaker) SetOverrideCircuitNameHandler

func (c *CircuitBreaker) SetOverrideCircuitNameHandler(f func(string) string)

type Command

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

func NewCommand

func NewCommand(ctx context.Context, functors []*Functor) *Command

func (*Command) Add

func (cmd *Command) Add(ftor *Functor)

func (*Command) Cancel

func (cmd *Command) Cancel()

func (*Command) IsEmpty

func (cmd *Command) IsEmpty() bool

type CommandResult

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

func (CommandResult) Error

func (cr CommandResult) Error() error

func (CommandResult) Result

func (cr CommandResult) Result() []any

type Config

type Config struct {
	Timeout                int
	MaxConcurrentRequests  int
	RequestVolumeThreshold int
	SleepWindow            int
	ErrorPercentThreshold  int
}

type FallbackFunc

type FallbackFunc func() ([]any, error)

type Functor

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

func NewFunctor

func NewFunctor(exec FallbackFunc, circuitName string) *Functor