service

Documentation

Index

• Constants
• type Service
  • func WithStart(start func()) Service
  • func WithStarter(start Starter) Service
• type ServiceConf
  • func (sc ServiceConf) MustSetUp()
  • func (sc ServiceConf) SetUp() error
• type ServiceGroup
  • func NewServiceGroup() *ServiceGroup
  • func (sg *ServiceGroup) Add(service Service)
  • func (sg *ServiceGroup) Start()
  • func (sg *ServiceGroup) Stop()
• type Starter
• type Stopper

Constants

const (
	// DevMode means development mode.
	DevMode = "dev"
	// TestMode means test mode.
	TestMode = "test"
	// RtMode means regression test mode.
	RtMode = "rt"
	// PreMode means pre-release mode.
	PreMode = "pre"
	// ProMode means production mode.
	ProMode = "pro"
)

Types

type Service

type Service interface {
	Starter
	Stopper
}

Service is the interface that groups Start and Stop methods.

func WithStart

func WithStart(start func()) Service

WithStart wraps a start func as a Service.

func WithStarter

func WithStarter(start Starter) Service

WithStarter wraps a Starter as a Service.

type ServiceConf

type ServiceConf struct {
	Name       string
	Log        logx.LogConf
	Mode       string            `json:",default=pro,options=dev|test|rt|pre|pro"`
	MetricsUrl string            `json:",optional"`
	Prometheus prometheus.Config `json:",optional"`
}

A ServiceConf is a service config.

func (ServiceConf) MustSetUp

func (sc ServiceConf) MustSetUp()

MustSetUp sets up the service, exits on error.

func (ServiceConf) SetUp

func (sc ServiceConf) SetUp() error

SetUp sets up the service.

type ServiceGroup

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

A ServiceGroup is a group of services.

func NewServiceGroup

func NewServiceGroup() *ServiceGroup

NewServiceGroup returns a ServiceGroup.

func (*ServiceGroup) Add

func (sg *ServiceGroup) Add(service Service)

Add adds service into sg.

func (*ServiceGroup) Start

func (sg *ServiceGroup) Start()

Start starts the ServiceGroup. There should not be any logic code after calling this method, because this method is a blocking one. Also, quitting this method will close the logx output.

func (*ServiceGroup) Stop

func (sg *ServiceGroup) Stop()

Stop stops the ServiceGroup.

type Starter

type Starter interface {
	Start()
}

Starter is the interface wraps the Start method.

type Stopper

type Stopper interface {
	Stop()
}

Stopper is the interface wraps the Stop method.