launchd

Documentation

Index

• func Install(plist Plist, log logger.Logger) error
• func PlistDestination(label string) string
• func Restart(label string, log logger.Logger) error
• func ShowStatus(label string, log logger.Logger) error
• func Start(label string, log logger.Logger) error
• func Stop(label string, wait bool, log logger.Logger) error
• func Uninstall(label string, wait bool, log logger.Logger) error
• type EnvVar
  • func NewEnvVar(key string, value string) EnvVar
• type Plist
  • func NewPlist(label string, binPath string, args []string, envVars []EnvVar, ...) Plist
  • func (p Plist) Check(path string) (bool, error)
• type Service
  • func ListServices(filters []string) (services []Service, err error)
  • func NewService(label string) Service
  • func (s Service) CheckPlist(plist Plist) (bool, error)
  • func (s Service) HasPlist() bool
  • func (s Service) Install(p Plist) error
  • func (s Service) Label() string
  • func (s Service) LoadStatus() (*ServiceStatus, error)
  • func (s Service) PlistDestination() string
  • func (s *Service) SetLogger(log logger.Logger)
  • func (s Service) Start() error
  • func (s Service) StatusDescription() string
  • func (s Service) Stop(wait bool) error
  • func (s Service) Uninstall(wait bool) (err error)
  • func (s Service) WaitForExit(wait time.Duration) error
• type ServiceStatus
  • func (s ServiceStatus) Description() string
  • func (s ServiceStatus) IsRunning() bool
  • func (s ServiceStatus) Label() string
  • func (s ServiceStatus) LastExitStatus() string
  • func (s ServiceStatus) Pid() string

Functions

func Install

func Install(plist Plist, log logger.Logger) error

Install will install a service

func PlistDestination

func PlistDestination(label string) string

func Restart

func Restart(label string, log logger.Logger) error

Restart restarts a service

func ShowStatus

func ShowStatus(label string, log logger.Logger) error

ShowStatus shows status info for a service

func Start

func Start(label string, log logger.Logger) error

Start will start a service

func Stop

func Stop(label string, wait bool, log logger.Logger) error

Stop will stop a service

func Uninstall

func Uninstall(label string, wait bool, log logger.Logger) error

Uninstall will uninstall a service

Types

type EnvVar

type EnvVar struct {
	// contains filtered or unexported fields
}

EnvVar defines and environment variable for the Plist

func NewEnvVar

func NewEnvVar(key string, value string) EnvVar

NewEnvVar creates a new environment variable

type Plist

type Plist struct {
	// contains filtered or unexported fields
}

Plist defines a launchd plist

func NewPlist

func NewPlist(label string, binPath string, args []string, envVars []EnvVar, logFileName string, comment string) Plist

NewPlist constructs a launchd service plist

func (Plist) Check

func (p Plist) Check(path string) (bool, error)

Check if plist matches plist at path

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service defines a service

func ListServices

func ListServices(filters []string) (services []Service, err error)

ListServices will return service with label that starts with a filter string.

func NewService

func NewService(label string) Service

NewService constructs a launchd service.

func (Service) CheckPlist

func (s Service) CheckPlist(plist Plist) (bool, error)

CheckPlist returns false, if the plist destination doesn't match what we would install. This means the plist is old and we need to update it.

func (Service) HasPlist

func (s Service) HasPlist() bool

HasPlist returns true if service has plist installed

func (Service) Install

func (s Service) Install(p Plist) error

Install will install the launchd service

func (Service) Label

func (s Service) Label() string

Label for service

func (Service) LoadStatus

func (s Service) LoadStatus() (*ServiceStatus, error)

Status returns service status

func (Service) PlistDestination

func (s Service) PlistDestination() string

func (*Service) SetLogger

func (s *Service) SetLogger(log logger.Logger)

func (Service) Start

func (s Service) Start() error

Load will start the service.

func (Service) StatusDescription

func (s Service) StatusDescription() string

StatusDescription returns the service status description

func (Service) Stop

func (s Service) Stop(wait bool) error

Stop a service.

func (Service) Uninstall

func (s Service) Uninstall(wait bool) (err error)

Uninstall will uninstall the launchd service

func (Service) WaitForExit

func (s Service) WaitForExit(wait time.Duration) error

WaitForExit waits for service to exit

type ServiceStatus

type ServiceStatus struct {
	// contains filtered or unexported fields
}

ServiceStatus defines status for a service

func (ServiceStatus) Description

func (s ServiceStatus) Description() string

Description returns service status info

func (ServiceStatus) IsRunning

func (s ServiceStatus) IsRunning() bool

IsRunning is true if the service is running (with a pid)

func (ServiceStatus) Label

func (s ServiceStatus) Label() string

Label for status

func (ServiceStatus) LastExitStatus

func (s ServiceStatus) LastExitStatus() string

LastExitStatus will be blank if pid > 0, or a number "123"

func (ServiceStatus) Pid

func (s ServiceStatus) Pid() string

Pid for status (empty string if not running)