microservice

README

micro-service

Documentation

Index

• Variables
• func BlockExit(callback BlockExitEndCallback)
• func InitService(appName string, settingsInst interface{}, initFunction InitFunction, ...)
• func ServiceSettings(creator settings.WatcherSettingsCreator, service ConsulService) (result *settings.Configuration, err error)
• type BlockExitEndCallback
• type ConsulService
• type Env
• type InitFunction
• type ServiceHealthCheck
• type ServiceInfo

Variables

var ConsulClient *api.Client

ConsulClient - client for consul (if it is using)

Functions

func BlockExit

func BlockExit(callback BlockExitEndCallback)

BlockExit - block exit (daemon mode)

func InitService

func InitService(appName string, settingsInst interface{}, initFunction InitFunction, service ConsulService, version string)

func ServiceSettings

func ServiceSettings(creator settings.WatcherSettingsCreator, service ConsulService) (result *settings.Configuration, err error)

ServiceSettings - setup micro-service configuration

Types

type BlockExitEndCallback

type BlockExitEndCallback func()

BlockExitEndCallback - callback function

type ConsulService

type ConsulService interface {
	Init(config settings.Configuration)
	GetServiceInfo() ServiceInfo
	GetServiceHealthCheck() []ServiceHealthCheck
}

ConsulService - consul service

type Env

type Env struct {
	Env string
	App string
}

type InitFunction

type InitFunction func(config *appSettings.Configuration) error

type ServiceHealthCheck

type ServiceHealthCheck struct {
	Name  string
	Notes string
	TTL   time.Duration
	Check func() error
}

ServiceHealthCheck - service health checker

type ServiceInfo

type ServiceInfo struct {
	Ports *[]int
}

ServiceInfo - service information