manager

Documentation

Overview

Package manager implements the component manager

Index

• type Component
• type Manager
  • func New() *Manager
  • func (m *Manager) Add(component Component)
  • func (m *Manager) Init(ctx context.Context) error
  • func (m *Manager) Start(ctx context.Context) error
  • func (m *Manager) Stop() error
• type Ready

Types

type Component

type Component interface {
	// Init initializes the component and prepares it for execution.
	Init(context.Context) error
	// Start starts the component.
	Start(context.Context) error
	// Stop stops this component, potentially cleaning up any temporary
	// resources attached to it.
	Stop() error
}

Component defines the lifecycle of managed components.

type Manager

type Manager struct {
	Components        []Component
	ReadyWaitDuration time.Duration
	// contains filtered or unexported fields
}

Manager manages components

func New

func New() *Manager

New creates a manager.

func (*Manager) Add

func (m *Manager) Add(component Component)

Add adds a component to the manager.

func (*Manager) Init

func (m *Manager) Init(ctx context.Context) error

Init initializes all managed components.

func (*Manager) Start

func (m *Manager) Start(ctx context.Context) error

Start starts all managed components.

func (*Manager) Stop

func (m *Manager) Stop() error

Stop stops all managed components.

type Ready

type Ready interface {
	// Ready performs a ready check and indicates that a component is ready to run.
	Ready() error
}

Ready is the interface for a component that can be checked for readiness.