app

package

v0.0.5 Latest Latest Go to latest Published: Jan 16, 2024 License: MIT Imports: 10 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/go-inspire/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

func NewContext(ctx context.Context, s AppInfo) context.Context
type App
- func New(opts ...Option) *App
type AppInfo
- func FromContext(ctx context.Context) (s AppInfo, ok bool)
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewContext ¶

func NewContext(ctx context.Context, s AppInfo) context.Context

NewContext returns a new Context that carries value.

Types ¶

type App ¶

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

App is an application components lifecycle manager

func New ¶

func New(opts ...Option) *App

New create an application lifecycle manager.

func (*App) ID ¶

func (a *App) ID() string

ID returns app instance id.

func (*App) Metadata ¶

func (a *App) Metadata() map[string]string

Metadata returns service metadata.

func (*App) Name ¶

func (a *App) Name() string

Name returns service name.

func (*App) Run ¶

func (a *App) Run() error

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

func (*App) Stop ¶

func (a *App) Stop() error

Stop gracefully stops the application.

func (*App) Version ¶

func (a *App) Version() string

Version returns app version.

type AppInfo ¶

type AppInfo interface {
	ID() string
	Name() string
	Version() string
	Metadata() map[string]string
}

AppInfo is application context value.

func FromContext ¶

func FromContext(ctx context.Context) (s AppInfo, ok bool)

FromContext returns the Transport value stored in ctx, if any.

type Option ¶

type Option func(o *options)

Option is an application option.

func Context ¶

func Context(ctx context.Context) Option

Context with service context.

func ID ¶

func ID(id string) Option

ID with service id.

func Metadata ¶

func Metadata(md map[string]string) Option

Metadata with service metadata.

func Name ¶

func Name(name string) Option

Name with service name.

func Server ¶

func Server(srv ...server.Server) Option

Server with transport servers.

func Signal ¶

func Signal(sigs ...os.Signal) Option

Signal with exit signals.

func Version ¶

func Version(version string) Option

Version with service version.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
server
test

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