zerobreaker

Documentation

Overview

Package zerobreaker

Package zerobreaker

Index

• Variables
• func NewBreaker(name string, opts ...Option) circuitbreaker.Breaker
• type Option
  • func WithName(name string) Option
• type Promise

Variables

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

ErrServiceUnavailable is returned when the Breaker state is open.

Functions

func NewBreaker

func NewBreaker(name string, opts ...Option) circuitbreaker.Breaker

NewBreaker returns a Breaker object. opts can be used to customize the Breaker.

Types

type Option

type Option func(breaker *circuitBreaker)

Option defines the method to customize a Breaker.

func WithName

func WithName(name string) Option

WithName returns a function to set the name of a Breaker.

type Promise

type Promise interface {
	// Accept tells the Breaker that the call is successful.
	Accept()
	// Reject tells the Breaker that the call is failed.
	Reject(reason string)
}

Promise interface defines the callbacks that returned by Breaker.Allow.