vapp

package

v0.0.0-...-1671bb8 Latest Latest Go to latest Published: Feb 20, 2021 License: Apache-2.0 Imports: 6 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

This section is empty.

This section is empty.

This section is empty.

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

App is an application components lifecycle manager

func New(opts ...Option) *App

New create an application lifecycle manager.

func (a *App) Append(lc Lifecycle)

Append register interface that are executed on application start and stop.

func (a *App) AppendHook(hook Hook)

AppendHook register callbacks that are executed on application start and stop.

func (a *App) Run() error

Run executes all OnStart hooks registered with the application's Lifecycle.

func (a *App) Stop()

Stop gracefully stops the application.

type Hook struct {
	OnStart func(context.Context) error
	OnStop  func(context.Context) error
}

Hook is a pair of start and stop callbacks.

type Lifecycle interface {
	Start(context.Context) error
	Stop(context.Context) error
}

Lifecycle is component lifecycle.

type Option func(o *options)

Option is an application option.

func Signal(fn func(*App, os.Signal), sigs ...os.Signal) Option

Signal with os signals.

func StartTimeout(d time.Duration) Option

StartTimeout with start timeout.

func StopTimeout(d time.Duration) Option

StopTimeout with stop timeout.