srv

Documentation

Index

• func Main(app App)
• func PrintDefaultCommand(out io.Writer)
• func PrintDefaultOptions()
• func PrintUsage(app App)
• func Wait(app App)
• type App
• type Cmd

Functions

func Main

func Main(app App)

Main server main

func PrintDefaultCommand

func PrintDefaultCommand(out io.Writer)

func PrintDefaultOptions

func PrintDefaultOptions()

func PrintUsage

func PrintUsage(app App)

func Wait

func Wait(app App)

Wait wait signal for reload or shutdown the app

Types

type App

type App interface {
	// Name app/service name
	Name() string

	// DisplayName app/service display name
	DisplayName() string

	// Description app/service description
	Description() string

	// Version app version
	Version() string

	// Usage print command line usage
	Usage()

	// Init initialize the app
	Init()

	// Reload reload the app
	Reload()

	// Run run the app
	Run()

	// Shutdown shutdown the app
	Shutdown()

	// Wait wait signal for reload or shutdown
	Wait()
}

type Cmd

type Cmd interface {
	// Flag set custom options
	Flag()

	// PrintCommand print custom command
	PrintCommand(out io.Writer)

	// Exec execute optional command except the internal command
	// Basic: 'help' 'usage' 'version'
	// Windows only: 'install' 'remove' 'start' 'stop' 'debug'
	Exec(cmd string)
}