life

Documentation

Overview

Package life provides application wide context with cancel function and some helper functions to register syscalls for smooth app termination and reloading (conf, logger and such).

Index

• type AppContext
  • func New() AppContext
  • func (a *AppContext) ByeTime() bool
  • func (a *AppContext) RegisterReloaders(sig syscall.Signal, reloaders ...Reloader)
  • func (a *AppContext) RegisterStopSignals(dieTimeout time.Duration, signals ...syscall.Signal)
  • func (a *AppContext) RunForever()
• type Reloader

Types

type AppContext

type AppContext struct {
	Context context.Context
	StopApp context.CancelFunc
}

AppContext represents application wide context with cancel function and some helper functions to register syscalls for smooth app termination and reloading (conf, logger and such)

func New

func New() AppContext

New prepares application wide context with cancel function and some helper functions to register syscalls for smooth app termination and reloading (conf, logger and such)

func (*AppContext) ByeTime

func (a *AppContext) ByeTime() bool

ByeTime is a helper that returns true if it's time for application to stop

func (*AppContext) RegisterReloaders

func (a *AppContext) RegisterReloaders(
	sig syscall.Signal, reloaders ...Reloader)

RegisterReloaders allows you to specify stuff you want to "reload" based on some signal (like reloading config, or rotating log file based on SIGHUP)

func (*AppContext) RegisterStopSignals

func (a *AppContext) RegisterStopSignals(dieTimeout time.Duration,
	signals ...syscall.Signal)

RegisterStopSignals handles signals that will terminate application After signal is received it cancels app wide context and waits specified interval before exiting

func (*AppContext) RunForever

func (a *AppContext) RunForever()

RunForever keeps main function running until there is a panic or kill signal NOTE: Call this directly from main, without go!

type Reloader

type Reloader interface {
	Reload()
}

Reloader interface ..