circuit

Documentation

Index

• type Breaker
  • func (b *Breaker) Close()
  • func (b *Breaker) Open()
  • func (b *Breaker) Safe() bool
• type Ready
  • func (r *Ready) Mark()
  • func (r *Ready) On() <-chan struct{}
• type Retry
  • func (retry *Retry) Attempt(method func() error) error

Types

type Breaker

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

Breaker is an object that will allow conncurrent checks if the breaker is safe to use. This object works very much like a real world electrical breaker.

func (*Breaker) Close

func (b *Breaker) Close()

Close closes the breaker thus making it safe

func (*Breaker) Open

func (b *Breaker) Open()

Open opens the breaker thus making is unsafe

func (*Breaker) Safe

func (b *Breaker) Safe() bool

Safe checks wheather the breaker is open or not

type Ready

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

Ready is a object that will mark once a entity is ready

func (*Ready) Mark

func (r *Ready) Mark()

Mark mark the instance as ready

func (*Ready) On

func (r *Ready) On() <-chan struct{}

On returns a channel that get's closed once the instance is marked as ready

type Retry

type Retry struct {
	Amount  int8 `json:"amount"`
	Retries int8
}

Retry allowes a given method to be retried x amount of times.

func (*Retry) Attempt

func (retry *Retry) Attempt(method func() error) error

Attempt tries to attempt the given method for the given amount of retries. If the method still fails after the set limit is a error returned.