reaper

Documentation

Index

• Variables
• func GetSubreaper() (int, error)
• func Reap() error
• func SetSubreaper(i int) error
• type Monitor
  • func (m *Monitor) Start(c *exec.Cmd) (chan runc.Exit, error)
  • func (m *Monitor) Subscribe() chan runc.Exit
  • func (m *Monitor) Unsubscribe(c chan runc.Exit)
  • func (m *Monitor) Wait(c *exec.Cmd, ec chan runc.Exit) (int, error)
  • func (m *Monitor) WaitTimeout(c *exec.Cmd, ec chan runc.Exit, timeout time.Duration) (int, error)

Variables

var Default = &Monitor{
	subscribers: make(map[chan runc.Exit]*subscriber),
}

Default is the default monitor initialized for the package

var ErrNoSuchProcess = errors.New("no such process")

ErrNoSuchProcess is returned when the process no longer exists

Functions

func GetSubreaper

func GetSubreaper() (int, error)

GetSubreaper returns the subreaper setting for the calling process

func Reap

func Reap() error

Reap should be called when the process receives an SIGCHLD. Reap will reap all exited processes and close their wait channels

func SetSubreaper

func SetSubreaper(i int) error

SetSubreaper sets the value i as the subreaper setting for the calling process

Types

type Monitor

type Monitor struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Monitor monitors the underlying system for process status changes

func (*Monitor) Start

func (m *Monitor) Start(c *exec.Cmd) (chan runc.Exit, error)

Start starts the command a registers the process with the reaper

func (*Monitor) Subscribe

func (m *Monitor) Subscribe() chan runc.Exit

Subscribe to process exit changes

func (*Monitor) Unsubscribe

func (m *Monitor) Unsubscribe(c chan runc.Exit)

Unsubscribe to process exit changes

func (*Monitor) Wait

func (m *Monitor) Wait(c *exec.Cmd, ec chan runc.Exit) (int, error)

Wait blocks until a process is signal as dead. User should rely on the value of the exit status to determine if the command was successful or not.

func (*Monitor) WaitTimeout

func (m *Monitor) WaitTimeout(c *exec.Cmd, ec chan runc.Exit, timeout time.Duration) (int, error)

WaitTimeout is used to skip the blocked command and kill the left process.