service

Documentation

Index

• func Run(app Service)
• func Since() time.Duration
• type BasicService
  • func NewBasicService[Config any](self Service, cfg config.Configurator[Config]) *BasicService[Config]
  • func (app *BasicService[Config]) AddModule(mod module.Module) module.Module
  • func (app *BasicService[Config]) Busy() bool
  • func (app *BasicService[Config]) Config() Config
  • func (app *BasicService[Config]) Discovery() discovery.Discovery
  • func (app *BasicService[Config]) ID() int64
  • func (app *BasicService[Config]) Init() error
  • func (app *BasicService[Config]) MQ() mq.Conn
  • func (app *BasicService[Config]) Name() string
  • func (app *BasicService[Config]) SetState(state State) error
  • func (app *BasicService[Config]) Shutdown() error
  • func (app *BasicService[Config]) Start() error
  • func (app *BasicService[Config]) State() State
  • func (app *BasicService[Config]) UUID() string
  • func (app *BasicService[Config]) Update(now time.Time, dt time.Duration)
• type DiscoveryContent
• type Meta
• type Service
• type State
  • func (state State) String() string

Functions

func Run

func Run(app Service)

Run runs the service

func Since

func Since() time.Duration

Since returns duration since started time

Types

type BasicService

type BasicService[Config any] struct {
	// contains filtered or unexported fields
}

BasicService implements Service

func NewBasicService

func NewBasicService[Config any](self Service, cfg config.Configurator[Config]) *BasicService[Config]

NewBasicService creates a BasicService

func (*BasicService[Config]) AddModule

func (app *BasicService[Config]) AddModule(mod module.Module) module.Module

AddModule adds a module to service

func (*BasicService[Config]) Busy

func (app *BasicService[Config]) Busy() bool

Busy implements Service Busy method

func (*BasicService[Config]) Config

func (app *BasicService[Config]) Config() Config

Config returns current config

func (*BasicService[Config]) Discovery

func (app *BasicService[Config]) Discovery() discovery.Discovery

Discovery returns the discovery engine

func (*BasicService[Config]) ID

func (app *BasicService[Config]) ID() int64

ID implements Service ID method

func (*BasicService[Config]) Init

func (app *BasicService[Config]) Init() error

Init implements Service Init method

func (*BasicService[Config]) MQ

func (app *BasicService[Config]) MQ() mq.Conn

MQ returns the mq engine

func (*BasicService[Config]) Name

func (app *BasicService[Config]) Name() string

Name implements Service Name method

func (*BasicService[Config]) SetState

func (app *BasicService[Config]) SetState(state State) error

SetState implements Service SetState method

func (*BasicService[Config]) Shutdown

func (app *BasicService[Config]) Shutdown() error

Shutdown implements Service Shutdown method

func (*BasicService[Config]) Start

func (app *BasicService[Config]) Start() error

Start implements Service Start method

func (*BasicService[Config]) State

func (app *BasicService[Config]) State() State

State returns state of service

func (*BasicService[Config]) UUID

func (app *BasicService[Config]) UUID() string

UUID implements service UUID method

func (*BasicService[Config]) Update

func (app *BasicService[Config]) Update(now time.Time, dt time.Duration)

Update updates per frame

type DiscoveryContent

type DiscoveryContent struct {
	Config any `json:"config"` // config of service
	State  struct {
		Updated int64  `json:"updated"`
		PID     int    `json:"pid"`   // process id
		State   State  `json:"state"` // run state
		UUID    string `json:"uuid"`  // instance uuid
	} `json:"state"` // runtime state of service
}

DiscoveryContent is the content for registering

type Meta

type Meta interface {
	// ID returns id of service
	ID() int64
	// Name of service
	Name() string
	// Global unique instance id of service
	UUID() string
	// Busy reports whether the service is busy
	Busy() bool
	// State returns state of service
	State() State
}

Meta represents metadata of service

type Service

type Service interface {
	Meta

	// SetState sets state of service
	SetState(state State) error
	// Init initializes the service
	Init() error
	// Start starts the service
	Start() error
	// Shutdown shutdowns the service
	Shutdown() error
}

Service represents a process

type State

type State int

State represents service state

const (
	Closed   State = iota // Closed service
	Running               // Running service
	Stopping              // Stopping service
)

func (State) String

func (state State) String() string