Documentation
¶
Overview ¶
Package breaker contains useful thread-safe abstraction the helps to control lifetime of actors, background tasks, pools etc.
Index ¶
- Variables
- type Breaker
- func (b *Breaker) Deadline() (time.Time, bool)
- func (b Breaker) Dec()
- func (b *Breaker) Done() <-chan struct{}
- func (b Breaker) Err() error
- func (b Breaker) Inc() error
- func (b Breaker) IsOperational() bool
- func (b *Breaker) Shutdown()
- func (b *Breaker) ShutdownAndWait()
- func (b *Breaker) Value(_ any) any
- func (b Breaker) Wait()
Constants ¶
This section is empty.
Variables ¶
var ( // ErrShutdown indicates that the breaker has already shut down. ErrShutdown = errors.New("breaker is shut down") // ErrShuttingDown indicates that shutdown has started // and the breaker no longer accepts new tasks. ErrShuttingDown = errors.New("breaker is shutting down") )
Functions ¶
This section is empty.
Types ¶
type Breaker ¶
type Breaker struct {
// contains filtered or unexported fields
}
Breaker can be used to stop any subsystem with background tasks gracefully.
func NewBreakerWithInitValue ¶
NewBreakerWithInitValue - alternative breaker constructor convenient for usage in pools and actors, when you know how many goroutines will work from the very beginning.
func (*Breaker) Deadline ¶
Deadline is implemented for the sake of compatibility with context.Context.
func (*Breaker) Done ¶
func (b *Breaker) Done() <-chan struct{}
Done returns channel which can be used in a manner similar to context.Context.Done().
func (Breaker) Err ¶
func (b Breaker) Err() error
Err mirrors context.Context semantics: nil while operational, otherwise ErrShutdown.
func (Breaker) IsOperational ¶ added in v0.0.2
func (b Breaker) IsOperational() bool
IsOperational reports whether the breaker is still accepting new tasks.
func (*Breaker) ShutdownAndWait ¶
func (b *Breaker) ShutdownAndWait()
ShutdownAndWait switches breakers in shutdown mode and waits for all background tasks to terminate.
Source Files