rununit

Documentation

Index

• type RunUnit
  • func New(run, stop func(), logger func(ent *logi.Entry) (e error), ...) (r *RunUnit)
  • func (r *RunUnit) Running() bool
  • func (r *RunUnit) Shutdown()
  • func (r *RunUnit) ShuttingDown() bool
  • func (r *RunUnit) Start()
  • func (r *RunUnit) Stop()

Types

type RunUnit

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

RunUnit handles correctly starting and stopping child processes that have StdConn pipe logging enabled, allowing custom hooks to run on start and stop,

func New

func New(
	run, stop func(),
	logger func(ent *logi.Entry) (e error),
	pkgFilter func(pkg string) (out bool),
	quit qu.C,
	args ...string,
) (r *RunUnit)

New creates and starts a new rununit. run and stop functions are executed after starting and stopping. logger receives log entries and processes them (such as logging them).

func (*RunUnit) Running

func (r *RunUnit) Running() bool

Running returns whether the unit is running

func (*RunUnit) Shutdown

func (r *RunUnit) Shutdown()

Shutdown terminates the run unit

func (*RunUnit) ShuttingDown

func (r *RunUnit) ShuttingDown() bool

ShuttingDown returns true if the server is shuting down

func (*RunUnit) Start

func (r *RunUnit) Start()

Start signals the run unit to start

func (*RunUnit) Stop

func (r *RunUnit) Stop()

Stop signals the run unit to stop