control

Documentation

Overview

Package control implements the control.core microservice.

This microservice is created for the sake of generating the client API for the :888 control subscriptions. The microservice itself does nothing and should not be included in applications.

Index

• Constants
• type Mock
  • func NewMock() *Mock
• type Service
  • func NewService() *Service
  • func (svc *Service) ConfigRefresh(ctx context.Context) (err error)
  • func (svc *Service) Init(initializer func(svc *Service)) *Service
  • func (svc *Service) OnShutdown(ctx context.Context) (err error)
  • func (svc *Service) OnStartup(ctx context.Context) (err error)
  • func (svc *Service) Ping(ctx context.Context) (pong int, err error)
  • func (svc *Service) Trace(ctx context.Context, id string) (err error)

Constants

const Hostname = "control.core"

Hostname is the default hostname of the microservice: control.core.

const SourceCodeSHA256 = "c3164e9d0c957aa6effde2f0361bf0e08e413c90710ebf6a263b2331e781604b"

const Timestamp = "2024-08-01T15:49:24.02646Z"

const Version = 173

Types

type Mock

type Mock = intermediate.Mock

Mock is a mockable version of the control.core microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

New creates a new mockable version of the microservice.

type Service

type Service struct {
	*intermediate.Intermediate // DO NOT REMOVE
}

Service implements the control.core microservice.

This microservice is created for the sake of generating the client API for the :888 control subscriptions. The microservice itself does nothing and should not be included in applications.

func NewService

func NewService() *Service

NewService creates a new control.core microservice.

func (*Service) ConfigRefresh

func (svc *Service) ConfigRefresh(ctx context.Context) (err error)

ConfigRefresh pulls the latest config values from the configurator service.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service)) *Service

Init enables a single-statement pattern for initializing the microservice.

svc.Init(func(svc Service) {
	svc.SetGreeting("Hello")
})

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.

func (*Service) Ping

func (svc *Service) Ping(ctx context.Context) (pong int, err error)

Ping responds to the message with a pong.

func (*Service) Trace

func (svc *Service) Trace(ctx context.Context, id string) (err error)

Trace forces exporting the indicated tracing span.