service

Documentation

Index

• type Mode
  • func (m Mode) String() string
• type Service
  • func NewService(id string, conf *config.ServiceConfig) (*Service, error)
  • func (s *Service) EnableGracefulShutdown()
  • func (s *Service) Kill()
  • func (s *Service) Restart() (string, error)
  • func (s *Service) Start(mode string, verbose bool) (pid string, err error)

Types

type Mode

type Mode int

Mode represents how gmbh interacts with the process of the service

const (
	// Remote mode; as in not having been launched from the service launcher
	Remote Mode = 1 + iota

	// Managed mode; as in having been launched from the service launcher
	Managed
)

func (Mode) String

func (m Mode) String() string

type Service

type Service struct {
	ID      string
	Path    string
	Created time.Time
	Address string
	Mode    Mode

	// LogPath is where the std{out,err} of service's process' output will be
	// directed
	LogPath string

	// Static data associated with the service
	// Static *config.ServiceStatic
	Static *config.ServiceConfig

	// If managed, Process will hold the process controller
	Process process.Manager
}

Service represents a service including all static and runtime data

func NewService

func NewService(id string, conf *config.ServiceConfig) (*Service, error)

NewService tries to parse the required info from a config file located at path

func (*Service) EnableGracefulShutdown

func (s *Service) EnableGracefulShutdown()

EnableGracefulShutdown tells the process to stop attempting to restart

func (*Service) Kill

func (s *Service) Kill()

Kill a process

func (*Service) Restart

func (s *Service) Restart() (string, error)

Restart the process

func (*Service) Start

func (s *Service) Start(mode string, verbose bool) (pid string, err error)

Start attempts to fork/exec service and returns the pid, else error service must be in managed or remote mode