signals

Documentation

Index

• type Component
  • func NewComponent() *Component
  • func (c *Component) New(ctx context.Context, conf *Config) (Signal, error)
  • func (c *Component) Settings() *Config
• type Config
  • func (*Config) Description() string
  • func (*Config) Name() string
• type OSComponent
  • func (*OSComponent) New(_ context.Context, conf *OSConfig) (Signal, error)
  • func (*OSComponent) Settings() *OSConfig
• type OSConfig
  • func (*OSConfig) Description() string
  • func (*OSConfig) Name() string
• type Signal
  • func Load(ctx context.Context, source settings.Source, c *Component) (Signal, error)
  • func New(ctx context.Context, source settings.Source) (Signal, error)

Types

type Component

type Component struct {
	OS *OSComponent
}

Component enables creation of signal handlers to shut down a system.

func NewComponent

func NewComponent() *Component

NewComponent populates any defaults.

func (*Component) New

func (c *Component) New(ctx context.Context, conf *Config) (Signal, error)

New generates a new Signal from all installed signals.

func (*Component) Settings

func (c *Component) Settings() *Config

Settings generates a default configuration.

type Config

type Config struct {
	Installed []string `description:"Which signal handlers are installed. Choices are OS."`
	OS        *OSConfig
}

Config contains all configuration for enabling various shut down signals.

func (*Config) Description

func (*Config) Description() string

Description of the configuration for help output.

func (*Config) Name

func (*Config) Name() string

Name of the configuration as it appears in a file.

type OSComponent

type OSComponent struct{}

OSComponent enables creation of an OS signal handler.

func (*OSComponent) New

func (*OSComponent) New(_ context.Context, conf *OSConfig) (Signal, error)

New generates a new Signal using OS signals.

func (*OSComponent) Settings

func (*OSComponent) Settings() *OSConfig

Settings generates a default configuration.

type OSConfig

type OSConfig struct {
	Signals []int `description:"Which signals to listen for."`
}

OSConfig contains configuration for creating an OSSignal listener.

func (*OSConfig) Description

func (*OSConfig) Description() string

Description of the configuration for help output.

func (*OSConfig) Name

func (*OSConfig) Name() string

Name of the configuration as it might appear in a file.

type Signal

type Signal chan error

Signal indicates that a system should shut down.

func Load

func Load(ctx context.Context, source settings.Source, c *Component) (Signal, error)

Load is a convenience method for binding the source to the component.

func New

func New(ctx context.Context, source settings.Source) (Signal, error)

New is the top-level entry point for creating a new shutdown signal.