servicebase

README

servicebase

a go service base that allows me to quickly demo

Documentation

Index

• func Start(svc *Service)
• type Option
  • func WithHealthProbe(healthProbe bool) Option
  • func WithPort(port int) Option
  • func WithVersion(version int) Option
• type Service
  • func New(name string, options ...Option) (*Service, error)

Functions

func Start

func Start(svc *Service)

Types

type Option

type Option func(*Service)

func WithHealthProbe

func WithHealthProbe(healthProbe bool) Option

func WithPort

func WithPort(port int) Option

func WithVersion

func WithVersion(version int) Option

type Service

type Service struct {
	//public
	Name        string          `json:"Name"`
	Port        int             `json:"Port"`
	HealthProbe bool            `json:"HealthProbe"`
	ExitAppChan <-chan struct{} `json:"-"`
	GinEngine   *gin.Engine     `json:"-"`
	AppHealthz  bool            `json:"AppHealthz"`
	AppReadyz   bool            `json:"AppReadyz"`
	Version     int             `json:"Version"`
	// contains filtered or unexported fields
}

func New

func New(name string, options ...Option) (*Service, error)