service

Documentation

Overview

Package service defines a service that deals with exit signals.

Index

• Variables
• type Config
• type Manager
• type Service
  • func (s *Service) Config() interface{}
  • func (s *Service) Desc() string
  • func (s *Service) ID() string
  • func (s *Service) Name() string
  • func (s *Service) Needs() map[string]struct{}
  • func (s *Service) Plug(handlers map[string]interface{}) error
  • func (s *Service) Run(ctx context.Context, running, stopping func()) error
  • func (s *Service) SetConfig(config interface{}) error

Variables

var (
	// ErrNotManager is returned when the connected service is not a
	// manager.
	ErrNotManager = errors.New("connected service is not a manager")
)

Types

type Config

type Config struct {
	// Manager is the name of the manager service.
	Manager string `toml:"manager" comment:"The name of the manager service."`

	// AllowForcedShutdown allows forces shutdown by sending a second signal.
	AllowForcedShutdown bool `toml:"allow_forced_shutdown" comment:"Allow forced shutdown by sending second signal."`
}

Config contains configuration options for the Signal Handler service.

type Manager

type Manager interface {
	StopAll()
}

Manager represents a service manager.

type Service

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

Service is the Signal Handler service.

func (*Service) Config

func (s *Service) Config() interface{}

Config returns the current service configuration or creates one with good default values.

func (*Service) Desc

func (s *Service) Desc() string

Desc returns a description of what the service does.

func (*Service) ID

func (s *Service) ID() string

ID returns the unique identifier of the service.

func (*Service) Name

func (s *Service) Name() string

Name returns the human friendly name of the service.

func (*Service) Needs

func (s *Service) Needs() map[string]struct{}

Needs returns the set of services this service depends on.

func (*Service) Plug

func (s *Service) Plug(handlers map[string]interface{}) error

Plug sets the connected services.

func (*Service) Run

func (s *Service) Run(ctx context.Context, running, stopping func()) error

Run starts the service.

func (*Service) SetConfig

func (s *Service) SetConfig(config interface{}) error

SetConfig configures the service handler.