breaker

Documentation

Overview

Package breaker defines the standard interface for a circuit breaker.

Index

• type Breaker
• type MockBreaker
  • func (m *MockBreaker) Allow(ctx context.Context) (done func(ok bool), err error)

Types

type Breaker

type Breaker interface {
	// Allow indicates if a request can be executed. It returns a function to be
	// called with the result of the request execution if the request is allowed,
	// an error otherwise.
	Allow(ctx context.Context) (done func(ok bool), err error)
}

Breaker defines the method required for a circuit breaker.

type MockBreaker

type MockBreaker struct {
	AllowFunc func(context.Context) (func(bool), error)
}

MockBreaker is a test mock for the Breaker interface.

func (*MockBreaker) Allow

func (m *MockBreaker) Allow(ctx context.Context) (done func(ok bool), err error)