services

Documentation

Index

• Variables
• type Container
  • func NewContainer(sess *session.Context, addr *address.Address, svc *Service) (*Container, error)
  • func (c *Container) CanRetry() bool
  • func (c *Container) Cancel(err error)
  • func (c *Container) Done() <-chan struct{}
  • func (c *Container) HandleEvent(sess *session.Context, ev events.Event)
  • func (c *Container) HasTick() bool
  • func (c *Container) Info() *service.Info
  • func (c *Container) Listeners() []string
  • func (c *Container) Register(sess *session.Context) error
  • func (c *Container) Retries() int
  • func (c *Container) Settings() service.Config
  • func (c *Container) Start(ectx context.Context, sess *session.Context) (err error)
  • func (c *Container) Stop(sess *session.Context, e error) (err error)
  • func (c *Container) Tick(sess *session.Context, ts time.Time, delta time.Duration) error
  • func (c *Container) Tock(sess *session.Context, delta time.Duration, tps int) error
• type CronScheduler
• type Info
• type Service
  • func New(s service.Config) *Service
  • func (s *Service) Cron(setupFunc func(schedule CronScheduler))
  • func (s *Service) Name() string
  • func (s *Service) OnAnyEvent(cb events.ActionWithEvent[*session.Context])
  • func (s *Service) OnEvent(scope, key string, cb events.ActionWithEvent[*session.Context])
  • func (s *Service) OnRegister(action action.Action)
  • func (s *Service) OnStart(action action.Action)
  • func (s *Service) OnStop(action action.WithPrevErr)
  • func (s *Service) Slug() string
  • func (s *Service) Tick(action action.Tick)
  • func (s *Service) Tock(action action.Tock)
• type ServiceLoader
  • func NewLoader(sess *session.Context, svcs ...string) *ServiceLoader
  • func (sl *ServiceLoader) Err() error
  • func (sl *ServiceLoader) Load() <-chan struct{}
• type Settings
  • func (s Settings) Blueprint() (*settings.Blueprint, error)

Variables

var (
	Error = fmt.Errorf("services error")
	// StartEvent starts services defined in payload
	StartEvent = events.New("services", "start.services")
	StopEvent  = events.New("services", "stop.services")
)

Types

type Container

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

func NewContainer

func NewContainer(sess *session.Context, addr *address.Address, svc *Service) (*Container, error)

func (*Container) CanRetry

func (c *Container) CanRetry() bool

func (*Container) Cancel

func (c *Container) Cancel(err error)

func (*Container) Done

func (c *Container) Done() <-chan struct{}

func (*Container) HandleEvent

func (c *Container) HandleEvent(sess *session.Context, ev events.Event)

func (*Container) HasTick

func (c *Container) HasTick() bool

func (*Container) Info

func (c *Container) Info() *service.Info

func (*Container) Listeners

func (c *Container) Listeners() []string

func (*Container) Register

func (c *Container) Register(sess *session.Context) error

func (*Container) Retries

func (c *Container) Retries() int

func (*Container) Settings

func (c *Container) Settings() service.Config

func (*Container) Start

func (c *Container) Start(ectx context.Context, sess *session.Context) (err error)

func (*Container) Stop

func (c *Container) Stop(sess *session.Context, e error) (err error)

func (*Container) Tick

func (c *Container) Tick(sess *session.Context, ts time.Time, delta time.Duration) error

func (*Container) Tock

func (c *Container) Tock(sess *session.Context, delta time.Duration, tps int) error

type CronScheduler

type CronScheduler interface {
	Job(name, expr string, cb action.Action)
}

type Info

type Info interface {
	Running() bool
	Name() string
	StartedAt() time.Time
	StoppedAt() time.Time
	Addr() *address.Address
	Failed() bool
	Errs() map[time.Time]error
}

type Service

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

func New

func New(s service.Config) *Service

New cretes new draft service which you can compose before passing it to applciation or providing it from addon.

func (*Service) Cron

func (s *Service) Cron(setupFunc func(schedule CronScheduler))

Cron scheduled cron jobs to run when the service is running.

func (*Service) Name

func (s *Service) Name() string

func (*Service) OnAnyEvent

func (s *Service) OnAnyEvent(cb events.ActionWithEvent[*session.Context])

OnAnyEvent called when any event is received.

func (*Service) OnEvent

func (s *Service) OnEvent(scope, key string, cb events.ActionWithEvent[*session.Context])

OnEvent is called when a specific event is received.

func (*Service) OnRegister

func (s *Service) OnRegister(action action.Action)

OnRegister is called when app is preparing runtime and attaching services, This does not mean that service will be used or started.

func (*Service) OnStart

func (s *Service) OnStart(action action.Action)

OnStart is called when service is requested to be started. For instace when command is requiring this service or whenever service is required on runtime via sess.RequireService call.

Start can be called multiple times in case of service restarts. If you do not want to allow service restarts you should implement your logic in OnStop when it's called first time and check that state OnStart.

func (*Service) OnStop

func (s *Service) OnStop(action action.WithPrevErr)

OnStop is called when runtime request to stop the service is recieved.

func (*Service) Slug

func (s *Service) Slug() string

func (*Service) Tick

func (s *Service) Tick(action action.Tick)

OnTick when set will be called every application tick when service is in running state.

func (*Service) Tock

func (s *Service) Tock(action action.Tock)

OnTock is called after every tick.

type ServiceLoader

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

func NewLoader

func NewLoader(sess *session.Context, svcs ...string) *ServiceLoader

NewServiceLoader creates new service loader which can be used to load services.

func (*ServiceLoader) Err

func (sl *ServiceLoader) Err() error

func (*ServiceLoader) Load

func (sl *ServiceLoader) Load() <-chan struct{}

type Settings

type Settings struct {
	LoaderTimeout  settings.Duration `key:"loader_timeout,save" default:"30s" mutation:"once" desc:"Service loader timeout"`
	RunCronOnStart settings.Bool     `key:"cron_on_service_start,save" default:"false" mutation:"once" desc:"Run cron jobs on service start"`
}

func (Settings) Blueprint

func (s Settings) Blueprint() (*settings.Blueprint, error)