routine

Documentation

Index

• type Manager
  • func NewManager(logger hclog.Logger) *Manager
  • func (m *Manager) IsRunning(name string) bool
  • func (m *Manager) Start(ctx context.Context, name string, routine Routine) error
  • func (m *Manager) Stop(name string) <-chan struct{}
  • func (m *Manager) StopAll()
  • func (m *Manager) Wait()
• type Routine

Types

type Manager

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

func NewManager

func NewManager(logger hclog.Logger) *Manager

func (*Manager) IsRunning

func (m *Manager) IsRunning(name string) bool

func (*Manager) Start

func (m *Manager) Start(ctx context.Context, name string, routine Routine) error

func (*Manager) Stop

func (m *Manager) Stop(name string) <-chan struct{}

Caveat: The returned stoppedCh indicates that the routine is completed

It's possible that ctx is canceled, but stoppedCh not yet closed
Use mgr.IsRunning(name) than this stoppedCh to tell whether the
instance is still running (not cancelled or completed).

func (*Manager) StopAll

func (m *Manager) StopAll()

StopAll goroutines. Once StopAll is called, it is no longer safe to add no goroutines to the Manager.

func (*Manager) Wait

func (m *Manager) Wait()

Wait for all goroutines to stop after StopAll is called.

type Routine

type Routine func(ctx context.Context) error