service

Documentation

Overview

Core service infrastructure for servicing starting/stopping/SIGTERM, and heartbeating etc

Index

• Constants
• type Config
  • func NewConfig() Config
• type Service
  • func NewService(c Config) *Service
  • func (self *Service) Start() chan bool
  • func (self *Service) Stop()

Constants

const (
	// DefaultMessageBusURL is the default MessageBus URL for service communications.
	DefaultMessageBusURL = messagebus.DefaultUrl
	// DefaultHeartbeatFreq is the period between service heartbeats in seconds.
	DefaultHeartbeatFreq = int(3)
)

Types

type Config

type Config struct {
	MessageBusURL string `json:"service_message_bus"`
	ServiceName   string `json:"service_name"`
	HeartbeatFreq int    `json:"service_heartbeat_freq"`
}

Config represents the configuration for base service.

func NewConfig

func NewConfig() Config

NewConfig returns an instance of Config with defaults.

type Service

type Service struct {
	Config Config
	Status proto.Heartbeat_Status
	// contains filtered or unexported fields
}

func NewService

func NewService(c Config) *Service

func (*Service) Start

func (self *Service) Start() chan bool

func (*Service) Stop

func (self *Service) Stop()