service

Documentation

Index

• Constants
• Variables
• func Name(s Service) string
• func Run(name string, r Runner) error
• type Config
  • func (c Config) HasFlag(flag string) bool
• type ConfigDefaultTester
• type ConfigDuration
  • func (e ConfigDuration) IsDefault() bool
  • func (e ConfigDuration) Set(v string) error
  • func (e ConfigDuration) String() string
• type ConfigEntry
• type ConfigFileStorer
  • func (s ConfigFileStorer) LoadConfig(c map[string]ConfigEntry) error
  • func (s ConfigFileStorer) SaveConfig(c map[string]ConfigEntry) error
• type ConfigFlag
  • func (e ConfigFlag) IsDefault() bool
  • func (e ConfigFlag) Set(v string) error
  • func (e ConfigFlag) String() string
• type ConfigListEntry
• type ConfigStorer
• type ConfigUint
  • func (e ConfigUint) IsDefault() bool
  • func (e ConfigUint) Set(v string) error
  • func (e ConfigUint) String() string
• type ConfigValue
  • func (e ConfigValue) IsDefault() bool
  • func (e ConfigValue) Set(v string) error
  • func (e ConfigValue) String() string
• type RunMode
  • func CurrentRunMode() RunMode
• type Runner
• type Service
• type Status

Constants

const RunModeEnv = "SERVICE_RUN_MODE"

Variables

var (
	ErrNotSupported     = errors.New("system not supported")
	ErrAlreadyInstalled = errors.New("already installed")
	ErrNoInstalled      = errors.New("not installed")
)

Functions

func Name

func Name(s Service) string

Name returns the name of s.

func Run

func Run(name string, r Runner) error

Types

type Config

type Config struct {
	Name        string
	DisplayName string
	Description string
	Arguments   []string
	Flags       []string
}

func (Config) HasFlag

func (c Config) HasFlag(flag string) bool

type ConfigDefaultTester

type ConfigDefaultTester interface {
	IsDefault() bool
}

type ConfigDuration

type ConfigDuration struct {
	Value   *time.Duration
	Default time.Duration
}

func (ConfigDuration) IsDefault

func (e ConfigDuration) IsDefault() bool

func (ConfigDuration) Set

func (e ConfigDuration) Set(v string) error

func (ConfigDuration) String

func (e ConfigDuration) String() string

type ConfigEntry

type ConfigEntry interface {
	Set(string) error
	String() string
}

type ConfigFileStorer

type ConfigFileStorer struct {
	File string
}

func (ConfigFileStorer) LoadConfig

func (s ConfigFileStorer) LoadConfig(c map[string]ConfigEntry) error

func (ConfigFileStorer) SaveConfig

func (s ConfigFileStorer) SaveConfig(c map[string]ConfigEntry) error

type ConfigFlag

type ConfigFlag struct {
	Value   *bool
	Default bool
}

func (ConfigFlag) IsDefault

func (e ConfigFlag) IsDefault() bool

func (ConfigFlag) Set

func (e ConfigFlag) Set(v string) error

func (ConfigFlag) String

func (e ConfigFlag) String() string

type ConfigListEntry

type ConfigListEntry interface {
	ConfigEntry
	Strings() []string
}

type ConfigStorer

type ConfigStorer interface {
	SaveConfig(map[string]ConfigEntry) error
	LoadConfig(map[string]ConfigEntry) error
}

type ConfigUint

type ConfigUint struct {
	Value   *uint
	Default uint
}

func (ConfigUint) IsDefault

func (e ConfigUint) IsDefault() bool

func (ConfigUint) Set

func (e ConfigUint) Set(v string) error

func (ConfigUint) String

func (e ConfigUint) String() string

type ConfigValue

type ConfigValue struct {
	Value   *string
	Default string
}

func (ConfigValue) IsDefault

func (e ConfigValue) IsDefault() bool

func (ConfigValue) Set

func (e ConfigValue) Set(v string) error

func (ConfigValue) String

func (e ConfigValue) String() string

type RunMode

type RunMode int

const (
	// RunModeNone means the current process is not run as a service.
	RunModeNone RunMode = iota

	// RunModeService specifies that the process is running as a service.
	RunModeService
)

func CurrentRunMode

func CurrentRunMode() RunMode

type Runner

type Runner interface {
	Start() error
	Stop() error
	Log(msg string)
}

type Service

type Service interface {
	Install() error
	Uninstall() error

	Status() (Status, error)
	Start() error
	Stop() error
	Restart() error

	ConfigStorer
}

type Status

type Status int

const (
	StatusUnknown Status = iota
	StatusNotInstalled
	StatusRunning
	StatusStopped
)