service

Documentation

Index

• type BaseService
  • func NewBaseService(logger zerolog.Logger, name string, impl Service) *BaseService
  • func (bs *BaseService) Run(ctx context.Context) error
  • func (bs *BaseService) SetLogger(l zerolog.Logger)
  • func (bs *BaseService) String() string
• type Service

Types

type BaseService

type BaseService struct {
	Logger zerolog.Logger
	// contains filtered or unexported fields
}

BaseService provides a basic implementation of the Service interface.

func NewBaseService

func NewBaseService(logger zerolog.Logger, name string, impl Service) *BaseService

NewBaseService creates a new BaseService. The provided implementation (impl) should be the "subclass" that implements Run.

func (*BaseService) Run

func (bs *BaseService) Run(ctx context.Context) error

Run implements the Service interface. It logs the start of the service, then defers to the implementation's Run method to do the actual work. If impl is nil or the same as bs, it uses the default implementation.

func (*BaseService) SetLogger

func (bs *BaseService) SetLogger(l zerolog.Logger)

SetLogger sets the logger.

func (*BaseService) String

func (bs *BaseService) String() string

String returns the service name.

type Service

type Service interface {
	// Run starts the service and blocks until it is shut down via context cancellation,
	// an error occurs, or all work is done.
	Run(ctx context.Context) error
}

Service exposes a Run method that blocks until the service ends or the context is canceled.