stopqueue

Documentation

Overview

Package stopqueue contains a structure for running stop functions in a specific order

Index

• type Queue
  • func NewStopQueue() *Queue
  • func (s *Queue) Add(stopFunc StopFunc)
  • func (s *Queue) StopAll(ctx context.Context) error
• type StopFunc

Types

type Queue

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

Queue is a stack of stop functions that executes in LIFO order

func NewStopQueue

func NewStopQueue() *Queue

NewStopQueue creates a new stop queue

func (*Queue) Add

func (s *Queue) Add(stopFunc StopFunc)

Add appends the stop func onto the queue

func (*Queue) StopAll

func (s *Queue) StopAll(ctx context.Context) error

StopAll runs all stop funcs and clears queue. Returns all errors encountered

type StopFunc

type StopFunc func(context.Context) error

StopFunc is a function that defines how to stop