foundation

Documentation

Index

• Variables
• type Server
  • func Init(name string) *Server
  • func NewServer(name string) *Server
  • func (s *Server) ID() string
  • func (s *Server) Name() string
  • func (s *Server) Run(svc typhon.Service)
  • func (s *Server) Start(svc typhon.Service) error
  • func (s *Server) Stop(ctx context.Context)
  • func (s *Server) Version() string

Variables

var (
	// Version defines the version of a service (visible in Sentry, logs, etc).
	// It is changed at build time by the compiler to the commit used.
	Version = "dev"
)

Types

type Server

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

func Init

func Init(name string) *Server

Init sets up and returns a server we can register a service with.

func NewServer

func NewServer(name string) *Server

func (*Server) ID

func (s *Server) ID() string

ID returns the worker ID of this service, derived from hostname.

func (*Server) Name

func (s *Server) Name() string

Name returns the name of this service, e.g. service.foo

func (*Server) Run

func (s *Server) Run(svc typhon.Service)

Run runs a service with typhon, handling shutdown gracefully.

func (*Server) Start

func (s *Server) Start(svc typhon.Service) error

func (*Server) Stop

func (s *Server) Stop(ctx context.Context)

func (*Server) Version

func (s *Server) Version() string

Version returns the version of this service, set at compile time from git.