component

Documentation

Index

• Variables
• type Component
  • func NewComponent(main func(context.Context) error, opts ...Opt) Component
• type Opt
  • func WithOnHalt(f func(context.Context, error)) Opt
  • func WithOnInterrupt(f func(context.Context) error) Opt

Variables

var (
	ErrComponentIsNil        = errors.New("component is nil")
	ErrComponentIsNotRunning = errors.New("component is not running")
)

Types

type Component

type Component interface {
	Start(ctx context.Context) (result bool)
	Interrupt(ctx context.Context) (err error)

	IsInterrupted() bool
	IsHalted() bool
	IsStarted() bool
	IsRunning() bool

	WaitUntilStarted(ctx context.Context) error
	WaitUntilHalted(ctx context.Context) error

	Error() error
}

Жизненный цикл: Создан -> Запущен -> [Прерван] -> Остановлен/Завершён

func NewComponent

func NewComponent(main func(context.Context) error, opts ...Opt) Component

type Opt

type Opt = options.Opt[compOptions]

func WithOnHalt

func WithOnHalt(f func(context.Context, error)) Opt

func WithOnInterrupt

func WithOnInterrupt(f func(context.Context) error) Opt