svcf

README

svcf

Adds go-flags support to voi-svc

Uppdates https://github.com/voi-oss/svc

with an pre-init-stage that parses github.com/jessevdk/go-flags

Also add a nullworker which can be embedded in service which only want the init-stage (blocks until terminated.)

Documentation

Index

• type SVC
  • func New(s *svc.SVC, options ...SVCFOption) *SVC
  • func (s *SVC) AddFlagGroup(name string, fg interface{})
  • func (s *SVC) AddWorker(name string, w svc.Worker)
  • func (s *SVC) Run()
• type SVCFOption
  • func WithFlagHelpOut(w io.Writer) SVCFOption
  • func WithNoFlagHelp() SVCFOption

Types

type SVC

type SVC struct {
	*svc.SVC
	// contains filtered or unexported fields
}

func New

func New(s *svc.SVC, options ...SVCFOption) *SVC

func (*SVC) AddFlagGroup

func (s *SVC) AddFlagGroup(name string, fg interface{})

AddFlagGroup adds a flag group to the service without it requiring to be a worker. useful to get consistent flag parsing for multiple modules.

func (*SVC) AddWorker

func (s *SVC) AddWorker(name string, w svc.Worker)

Adds a worker which also gets flags parsing for config management through github.com/jessevdk/go-flags

func (*SVC) Run

func (s *SVC) Run()

Run runs the service until either receiving an interrupt or a worker terminates.

type SVCFOption

type SVCFOption func(s *SVC)

func WithFlagHelpOut

func WithFlagHelpOut(w io.Writer) SVCFOption

direct flag based help messages to this writer.

func WithNoFlagHelp

func WithNoFlagHelp() SVCFOption

stops printing flag help on startup.