service

Documentation

Index

• func Main(use, short string, s Runnable)
• func Run(service func(ctx context.Context, l logger.Logger) error) error
• type BindEnvironment
• type BindFlags
• type Runnable

Functions

func Main

func Main(use, short string, s Runnable)

Main runs your service, calling its BindFlags and BindEnvironment methods if it implements them, and then calling its Run method.

func Run

func Run(service func(ctx context.Context, l logger.Logger) error) error

Run a service. A context is created which will be canceled when the service receives a SIGINT or SIGTERM signal. A logger is created. These are passed to the service function. The logger is created with a level of DEBUG if the DEBUG environment variable is set to true.

Types

type BindEnvironment

type BindEnvironment interface {
	BindEnvironment() error
}

BindEnvironment can optionally be implemented by a service to bind environment variables to the service. BindEnvironment will be called after BindFlags and before Run.

type BindFlags

type BindFlags interface {
	BindFlags(flags *pflag.FlagSet)
}

BindFlags can optionally be implemented by a service to bind command line flags to the service. BindFlags will be called before BindEnvironment and Run.

type Runnable

type Runnable interface {
	Run(ctx context.Context, l logger.Logger) error
}

Runnable must be implemented by all services that are run with Main.