app

Documentation

Index

• Constants
• type Application
  • func NewApplication(cnf *Config) *Application
  • func (app *Application) Commit() string
  • func (app *Application) Configuration() *config.Config
  • func (app *Application) Context() context.Context
  • func (app *Application) Init()
  • func (app *Application) IsDebug() bool
  • func (app *Application) IsRunning() bool
  • func (app *Application) Logger() logger.ILogger
  • func (app *Application) Name() string
  • func (app *Application) ProcessManager() process.IManager
  • func (app *Application) Run()
  • func (app *Application) SetMainLoop(fn MainLoopFn)
  • func (app *Application) SetOnCHLD(fn OnSignalFn)
  • func (app *Application) SetOnExit(fn OnSignalFn)
  • func (app *Application) SetOnHUP(fn OnSignalFn)
  • func (app *Application) SetOnStart(fn OnSignalFn)
  • func (app *Application) SetOnUSR1(fn OnSignalFn)
  • func (app *Application) SetOnUSR2(fn OnSignalFn)
  • func (app *Application) SetOnWINCH(fn OnSignalFn)
  • func (app *Application) Terminate()
  • func (app *Application) Version() *semver.SemVer
• type Config
  • func NewConfig() *Config
• type MainLoopFn
• type OnSignalFn

Constants

const (
	// Time to sleep during main loop so we're a nice neighbour.
	EventLoopSleep time.Duration = 250 * time.Millisecond
)

Types

type Application

type Application struct {
	OnStart  OnSignalFn // Function called on app startup.
	OnExit   OnSignalFn // Function called on app exit.
	OnHUP    OnSignalFn // Function called when SIGHUP received.
	OnUSR1   OnSignalFn // Function called when SIGUSR1 received.
	OnUSR2   OnSignalFn // Function called when SIGUSR2 received.
	OnWINCH  OnSignalFn // Function used when SIGWINCH received.
	OnCHLD   OnSignalFn // Function used when SIGCHLD received.
	MainLoop MainLoopFn // Application main loop function.
	// contains filtered or unexported fields
}

func NewApplication

func NewApplication(cnf *Config) *Application

Create a new application.

func (*Application) Commit

func (app *Application) Commit() string

func (*Application) Configuration

func (app *Application) Configuration() *config.Config

func (*Application) Context

func (app *Application) Context() context.Context

Return the application's context.

func (*Application) Init

func (app *Application) Init()

func (*Application) IsDebug

func (app *Application) IsDebug() bool

Is the application using debug mode?

func (*Application) IsRunning

func (app *Application) IsRunning() bool

Is the application running?

func (*Application) Logger

func (app *Application) Logger() logger.ILogger

func (*Application) Name

func (app *Application) Name() string

func (*Application) ProcessManager

func (app *Application) ProcessManager() process.IManager

func (*Application) Run

func (app *Application) Run()

Start the application.

func (*Application) SetMainLoop

func (app *Application) SetMainLoop(fn MainLoopFn)

Set the main loop callback.

func (*Application) SetOnCHLD

func (app *Application) SetOnCHLD(fn OnSignalFn)

Set the `OnCHLD` callback.

func (*Application) SetOnExit

func (app *Application) SetOnExit(fn OnSignalFn)

Set the `OnExit` callback.

func (*Application) SetOnHUP

func (app *Application) SetOnHUP(fn OnSignalFn)

Set the `OnHUP` callback.

func (*Application) SetOnStart

func (app *Application) SetOnStart(fn OnSignalFn)

Set the `OnStart` callback.

func (*Application) SetOnUSR1

func (app *Application) SetOnUSR1(fn OnSignalFn)

Set the `OnUSR1` callback.

func (*Application) SetOnUSR2

func (app *Application) SetOnUSR2(fn OnSignalFn)

Set the `OnUSR2` callback.

func (*Application) SetOnWINCH

func (app *Application) SetOnWINCH(fn OnSignalFn)

Set the `OnWINCH` callback.

func (*Application) Terminate

func (app *Application) Terminate()

Stop the application.

func (*Application) Version

func (app *Application) Version() *semver.SemVer

type Config

type Config struct {
	Name           string
	Version        *semver.SemVer
	Logger         logger.ILogger
	ProcessManager process.IManager
	AppConfig      any
	Validators     config.ValidatorsMap
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig() *Config

type MainLoopFn

type MainLoopFn func(*Application) // Main loop callback function.

type OnSignalFn

type OnSignalFn func(*Application) // Signal callback function.