microservice

package module

v2.1.2 Latest Latest Go to latest Published: Sep 14, 2022 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitlab.com/shadowy/go/micro-service/v2

Links

Open Source Insights

README ¶

micro-service

Documentation ¶

Index ¶

Constants
Variables
func BlockExit(callback BlockExitEndCallback)
func InitContextService[T any](appName string, settingsInst T, initFunction InitContextFunction, ...)
func InitService(appName string, settingsInst interface{}, ...)
func ServiceSettings[T any](creator settings.WatcherSettingsCreator[T], service ConsulService[T]) (result *settings.Configuration[T], err error)
type BlockExitEndCallback
type ConsulRemoveRegistration
type ConsulService
type Env
type InitContextFunction
type InitFunction
type ServiceHealthCheck
type ServiceInfo

Constants ¶

View Source

const CfgContext = "cfg"

Variables ¶

View Source

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 InitContextService ¶ added in v2.1.0

func InitContextService[T any](appName string, settingsInst T, initFunction InitContextFunction, service ConsulService[T], version string)

func InitService ¶

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

func ServiceSettings ¶

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

ServiceSettings - setup micro-service configuration

Types ¶

type BlockExitEndCallback ¶

type BlockExitEndCallback func()

BlockExitEndCallback - callback function

type ConsulRemoveRegistration ¶ added in v2.1.1

type ConsulRemoveRegistration func()

type ConsulService ¶

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

ConsulService - consul service

type Env ¶

type Env struct {
	Env string
	App string
}

type InitContextFunction ¶ added in v2.1.0

type InitContextFunction func(ctx context.Context) error

type InitFunction ¶

type InitFunction[T any] func(config *appSettings.Configuration[T]) 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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL