component

package

v0.0.0-...-0d0b053 Latest Latest Go to latest Published: Mar 15, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/SlamJam/go-libs

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

component.go

Directories ¶

Path	Synopsis
input

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL