shutdowncoordinator

Documentation

Index

• type ShutdownCoordinator
  • func New(name string, parent *ShutdownCoordinator, log *logger.Logger) *ShutdownCoordinator
  • func (s *ShutdownCoordinator) AreAllSubComponentsDone() bool
  • func (s *ShutdownCoordinator) Done()
  • func (s *ShutdownCoordinator) Sub(name string) *ShutdownCoordinator
  • func (s *ShutdownCoordinator) Wait()
  • func (s *ShutdownCoordinator) WaitWithLogging()

Types

type ShutdownCoordinator

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

func New

func New(name string, parent *ShutdownCoordinator, log *logger.Logger) *ShutdownCoordinator

func (*ShutdownCoordinator) AreAllSubComponentsDone

func (s *ShutdownCoordinator) AreAllSubComponentsDone() bool

don't block, just check, if all the sub-tree is terminated.

func (*ShutdownCoordinator) Done

func (s *ShutdownCoordinator) Done()

func (*ShutdownCoordinator) Sub

func (s *ShutdownCoordinator) Sub(name string) *ShutdownCoordinator

makes a subcontext, with a name (for debugging).

func (*ShutdownCoordinator) Wait

func (s *ShutdownCoordinator) Wait()

func (*ShutdownCoordinator) WaitWithLogging

func (s *ShutdownCoordinator) WaitWithLogging()

waits to for all the hierarchy to complete. (same as Wait(), but logs what components are still being waited for)