daemon

Documentation

Overview

Package daemon program is installed as a system service to achieve process daemon

Index

• Variables
• func IsPermissionError(err error) bool
• type Config
• type Iface
• type ServiceIface
  • func New(i Iface, c *Config) (ServiceIface, error)
• type SystemIface

Variables

var (
	ErrNameFieldRequired       = errors.New("config.name field is required")
	ErrNoServiceSystemDetected = errors.New("no service system detected")
	ErrNotAnRootUser           = errors.New("need to execute with sudo permission")
	ErrNotAnAdministrator      = errors.New("please operate with administrator rights")
)

Functions

func IsPermissionError

func IsPermissionError(err error) bool

Types

type Config

type Config struct {
	Name        string
	DisplayName string
	Description string
	UserName    string
	Arguments   []string
	Executable  string
	WorkingDir  string
	RootDir     string
	// System specific options
	//  * OS X
	//    - KeepAlive     bool (true)
	//    - RunAtLoad     bool (true)
	//    - UserService   bool (false) - Install as a current user service.
	//    - SessionCreate bool (false) - Create a full user session.
	//  * POSIX
	//    - RunWait      func() (wait for SIGNAL) - Do not install signal but wait for this function to return.
	//    - ReloadSignal string () [USR1, ...] - Signal to send on reaload.
	//    - PIDFile     string () [/run/prog.pid] - Location of the PID file.
	Option map[string]interface{}
}

Config provides the setup for a ServiceIface. The Name field is required.

type Iface

type Iface interface {
	Start(s ServiceIface) error
	Stop(s ServiceIface) error
}

type ServiceIface

type ServiceIface interface {
	Run() error
	Start() error
	Stop() error
	Restart() error
	Install() error
	Uninstall() error
	Status() string
	String() string
}

ServiceIface represents a service that can be run or controlled

func New

func New(i Iface, c *Config) (ServiceIface, error)

New creates a new service based on a service interface and configuration

type SystemIface

type SystemIface interface {
	String() string
	Interactive() bool
	Detect() bool
	New(i Iface, c *Config) (ServiceIface, error)
}