servicetoolset

Documentation

Index

• func ClientAuthTypeMap(ca ClientAuthType) tls.ClientAuthType
• func GenClientTLSConfig(cfg *GRPCClientTLSConfig) (tlsConfig *tls.Config, err error)
• func GenServerTLSConfig(cfg *GRPCServerTLSConfig) (tlsConfig *tls.Config, err error)
• func GetDiscoveryHostAndPort(externalAddress, listeningAddress string) (host string, port int, err error)
• func NewGRPCWebHandler(parameters GRPCWebHandlerInputParameters) (http.Handler, error)
• func SignalContext(ctx context.Context, logger l.Wrapper) context.Context
• type AbstractServer
• type BeforeServerStart
• type ClientAuthType
• type DiscoveryExConfig
• type GRPCClientTLSConfig
  • func GRPCClientTLSConfigMap(fileCfg *GRPCClientTLSFileConfig) (*GRPCClientTLSConfig, error)
• type GRPCClientTLSFileConfig
• type GRPCServer
  • func NewGRPCServer(routineMan routineman.RoutineMan, cfg *GRPCServerConfig, ...) (GRPCServer, error)
• type GRPCServerConfig
• type GRPCServerTLSConfig
  • func GRPCServerTLSConfigMap(fileCfg *GRPCServerTLSFileConfig) (*GRPCServerTLSConfig, error)
• type GRPCServerTLSFileConfig
• type GRPCWebHandlerInputParameters
• type HTTPServer
  • func NewHTTPServer(name, address string, handler http.Handler, ...) HTTPServer
• type HTTPServerConfig
• type ServerHelper
  • func NewServerHelper(ctx context.Context, logger l.Wrapper) *ServerHelper
  • func (sh *ServerHelper) StartServer(s AbstractServer)
  • func (sh *ServerHelper) Wait()
• type ServerToolset
  • func NewServerToolset(ctx context.Context, logger l.Wrapper) *ServerToolset
  • func (st *ServerToolset) CreateGRpcServer(cfg *GRPCServerConfig, opts []grpc.ServerOption, ...) (err error)
  • func (st *ServerToolset) CreateHTTPServer(cfg *HTTPServerConfig) error
  • func (st *ServerToolset) Start() error
  • func (st *ServerToolset) Wait()

Functions

func ClientAuthTypeMap

func ClientAuthTypeMap(ca ClientAuthType) tls.ClientAuthType

func GenClientTLSConfig

func GenClientTLSConfig(cfg *GRPCClientTLSConfig) (tlsConfig *tls.Config, err error)

func GenServerTLSConfig

func GenServerTLSConfig(cfg *GRPCServerTLSConfig) (tlsConfig *tls.Config, err error)

func GetDiscoveryHostAndPort

func GetDiscoveryHostAndPort(externalAddress, listeningAddress string) (host string, port int, err error)

func NewGRPCWebHandler

func NewGRPCWebHandler(parameters GRPCWebHandlerInputParameters) (http.Handler, error)

func SignalContext

func SignalContext(ctx context.Context, logger l.Wrapper) context.Context

Types

type AbstractServer

type AbstractServer interface {
	Run(ctx context.Context) error
}

type BeforeServerStart

type BeforeServerStart func(server *grpc.Server) error

type ClientAuthType

type ClientAuthType int

const (
	RequireAndVerifyClientCert ClientAuthType = iota
	NoClientCert
	RequestClientCert
	RequireAnyClientCert
	VerifyClientCertIfGiven
)

type DiscoveryExConfig

type DiscoveryExConfig struct {
	Setter          discovery.Setter  `json:"-" yaml:"-" ignored:"true"`
	ExternalAddress string            `yaml:"external_address" json:"external_address"`
	Meta            map[string]string `yaml:"meta" json:"meta"`
}

type GRPCClientTLSConfig

type GRPCClientTLSConfig struct {
	DisableSystemPool  bool   `yaml:"DisableSystemPool" json:"disable_system_pool"`
	ServerName         string `yaml:"ServerName" json:"server_name"`
	InsecureSkipVerify bool   `yaml:"InsecureSkipVerify" json:"insecure_skip_verify"`

	RootCAs [][]byte `yaml:"RootCAs" json:"root_cas" `
	Cert    []byte   `yaml:"Cert" json:"cert"`
	Key     []byte   `yaml:"Key" json:"key"`
}

func GRPCClientTLSConfigMap

func GRPCClientTLSConfigMap(fileCfg *GRPCClientTLSFileConfig) (*GRPCClientTLSConfig, error)

type GRPCClientTLSFileConfig

type GRPCClientTLSFileConfig struct {
	DisableSystemPool  bool   `yaml:"DisableSystemPool" json:"disable_system_pool"`
	ServerName         string `yaml:"ServerName" json:"server_name"`
	InsecureSkipVerify bool   `yaml:"InsecureSkipVerify" json:"insecure_skip_verify"`

	RootCAs []string `yaml:"RootCAs" json:"root_cas" `
	Cert    string   `yaml:"Cert" json:"cert"`
	Key     string   `yaml:"Key" json:"key"`
}

type GRPCServer

type GRPCServer interface {
	Start(init BeforeServerStart) (err error)
	Wait()
	Stop()
	StopAndWait()

	Run(ctx context.Context) (err error)
}

func NewGRPCServer

func NewGRPCServer(routineMan routineman.RoutineMan, cfg *GRPCServerConfig, opts []grpc.ServerOption,
	defInit BeforeServerStart, logger l.Wrapper, extraInterceptors ...interface{}) (GRPCServer, error)

type GRPCServerConfig

type GRPCServerConfig struct {
	Address    string               `yaml:"address" json:"address"`
	TLSConfig  *GRPCServerTLSConfig `yaml:"tls_config" json:"tls_config"`
	WebAddress string               `yaml:"web_address" json:"web_address"`

	Name              string             `yaml:"name" json:"name"`
	MetaTransKeys     []string           `yaml:"meta_trans_keys" json:"meta_trans_keys"`
	DiscoveryExConfig *DiscoveryExConfig `yaml:"discovery_ex_config" json:"discovery_ex_config"`

	KeepAliveDuration        time.Duration `yaml:"keep_alive_duration" json:"keep_alive_duration"`
	EnforcementPolicyMinTime time.Duration `yaml:"enforcement_policy_min_time" json:"enforcement_policy_min_time"`
}

type GRPCServerTLSConfig

type GRPCServerTLSConfig struct {
	DisableSystemPool bool           `yaml:"DisableSystemPool" json:"disable_system_pool"`
	ClientAuth        ClientAuthType `yaml:"ClientAuth" json:"client_auth"`

	RootCAs [][]byte `yaml:"RootCAs" json:"root_cas" `
	Cert    []byte   `yaml:"Cert" json:"cert"`
	Key     []byte   `yaml:"Key" json:"key"`
}

func GRPCServerTLSConfigMap

func GRPCServerTLSConfigMap(fileCfg *GRPCServerTLSFileConfig) (*GRPCServerTLSConfig, error)

type GRPCServerTLSFileConfig

type GRPCServerTLSFileConfig struct {
	DisableSystemPool bool           `yaml:"DisableSystemPool" json:"disable_system_pool"`
	ClientAuth        ClientAuthType `yaml:"ClientAuth" json:"client_auth"`

	RootCAs []string `yaml:"RootCAs" json:"root_cas" `
	Cert    string   `yaml:"Cert" json:"cert"`
	Key     string   `yaml:"Key" json:"key"`
}

type GRPCWebHandlerInputParameters

type GRPCWebHandlerInputParameters struct {
	GRPCServer          *grpc.Server
	GRPCWebUseWebsocket bool
	GRPCWebPingInterval time.Duration
}

type HTTPServer

type HTTPServer interface {
	Run(ctx context.Context) (err error)
}

func NewHTTPServer

func NewHTTPServer(name, address string, handler http.Handler, discoveryExConfig *DiscoveryExConfig, logger l.Wrapper) HTTPServer

type HTTPServerConfig

type HTTPServerConfig struct {
	Name              string            `yaml:"name" json:"name"`
	Address           string            `yaml:"address" json:"address"`
	Handler           http.Handler      `json:"-" yaml:"-"`
	DiscoveryExConfig DiscoveryExConfig `yaml:"discovery_ex_config" json:"discovery_ex_config"`
}

type ServerHelper

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

func NewServerHelper

func NewServerHelper(ctx context.Context, logger l.Wrapper) *ServerHelper

func (*ServerHelper) StartServer

func (sh *ServerHelper) StartServer(s AbstractServer)

func (*ServerHelper) Wait

func (sh *ServerHelper) Wait()

type ServerToolset

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

func NewServerToolset

func NewServerToolset(ctx context.Context, logger l.Wrapper) *ServerToolset

func (*ServerToolset) CreateGRpcServer

func (st *ServerToolset) CreateGRpcServer(cfg *GRPCServerConfig, opts []grpc.ServerOption, beforeServerStart BeforeServerStart) (err error)

func (*ServerToolset) CreateHTTPServer

func (st *ServerToolset) CreateHTTPServer(cfg *HTTPServerConfig) error

func (*ServerToolset) Start

func (st *ServerToolset) Start() error

func (*ServerToolset) Wait

func (st *ServerToolset) Wait()