web

Documentation

Index

• Constants
• Variables
• type APIParams
• type GRPCOption
  • func GRPCListenAddress(addr string) GRPCOption
  • func GRPCListenNetwork(network string) GRPCOption
  • func GRPCShutdownTimeout(v time.Duration) GRPCOption
  • func GRPCSkipErrors() GRPCOption
• type HTTPOption
  • func HTTPListenAddress(address string) HTTPOption
  • func HTTPListenNetwork(network string) HTTPOption
  • func HTTPShutdownTimeout(v time.Duration) HTTPOption
  • func HTTPSkipErrors() HTTPOption
• type Listener
• type ListenerOption
  • func ListenerIgnoreError(errors ...error) ListenerOption
  • func ListenerShutdownTimeout(v time.Duration) ListenerOption
  • func ListenerSkipErrors() ListenerOption
• type MultiServerParams
• type ServerResult
  • func NewAPIServer(p APIParams) (ServerResult, error)
  • func NewGRPCServer(v *viper.Viper, key string, s *grpc.Server, l *zap.Logger) (ServerResult, error)
  • func NewHTTPServer(v *viper.Viper, key string, h http.Handler, l *zap.Logger) (ServerResult, error)
• type Service
  • func New(log *zap.Logger, services ...Service) (Service, error)
  • func NewGRPCService(serve *grpc.Server, opts ...GRPCOption) (Service, error)
  • func NewHTTPService(serve *http.Server, opts ...HTTPOption) (Service, error)
  • func NewListener(lis Listener, opts ...ListenerOption) (Service, error)
  • func NewMultiServer(p MultiServerParams) (Service, error)

Constants

const (
	// ErrEmptyGRPCServer is raised when called NewGRPCService
	// or gRPC methods with empty grpc.Server.
	ErrEmptyGRPCServer = internal.Error("empty gRPC server")

	// ErrEmptyGRPCAddress is raised when passed empty address to NewGRPCService.
	ErrEmptyGRPCAddress = internal.Error("empty gRPC address")
)

const (
	// ErrEmptyHTTPServer is raised when called New
	// or httpService methods with empty http.Server.
	ErrEmptyHTTPServer = internal.Error("empty http server")

	// ErrEmptyHTTPAddress is raised when passed empty address to NewHTTPService.
	ErrEmptyHTTPAddress = internal.Error("empty http address")
)

const (
	// ErrEmptyLogger is raised when empty logger passed into New function.
	ErrEmptyLogger = internal.Error("empty logger")

	// ErrEmptyServices is raised when empty services passed into New function.
	ErrEmptyServices = internal.Error("empty services")
)

const ErrEmptyListener = internal.Error("empty listener")

ErrEmptyListener is raised when an empty Listener used in the NewListener function or Listener methods.

Variables

var (
	// ServersModule of web base structs
	ServersModule = module.Module{
		{Constructor: newDefaultGRPCServer},
		{Constructor: newProfileServer},
		{Constructor: newMetricServer},
		{Constructor: NewAPIServer},
		{Constructor: NewMultiServer},
	}
)

Types

type APIParams

type APIParams struct {
	dig.In

	Config  *viper.Viper
	Logger  *zap.Logger
	Handler http.Handler `optional:"true"`
}

APIParams struct

type GRPCOption

type GRPCOption func(g *gRPC)

GRPCOption allows changing default gRPC service settings.

func GRPCListenAddress

func GRPCListenAddress(addr string) GRPCOption

GRPCListenAddress allows to change network for net.Listener.

func GRPCListenNetwork

func GRPCListenNetwork(network string) GRPCOption

GRPCListenNetwork allows to change default (tcp) network for net.Listener.

func GRPCShutdownTimeout

func GRPCShutdownTimeout(v time.Duration) GRPCOption

GRPCShutdownTimeout changes default shutdown timeout.

func GRPCSkipErrors

func GRPCSkipErrors() GRPCOption

GRPCSkipErrors allows to skip any errors

type HTTPOption

type HTTPOption func(s *httpService)

HTTPOption interface that allows to change default http-service options.

func HTTPListenAddress

func HTTPListenAddress(address string) HTTPOption

HTTPListenAddress allows to change network for net.Listener. By default it takes address from http.Server.

func HTTPListenNetwork

func HTTPListenNetwork(network string) HTTPOption

HTTPListenNetwork allows to change default (tcp) network for net.Listener.

func HTTPShutdownTimeout

func HTTPShutdownTimeout(v time.Duration) HTTPOption

HTTPShutdownTimeout changes default shutdown timeout.

func HTTPSkipErrors

func HTTPSkipErrors() HTTPOption

HTTPSkipErrors allows to skip any errors

type Listener

type Listener interface {
	ListenAndServe() error
	Shutdown(context.Context) error
}

Listener service interface.

type ListenerOption

type ListenerOption func(l *listener)

ListenerOption options that allows to change default settings for Listener service.

func ListenerIgnoreError

func ListenerIgnoreError(errors ...error) ListenerOption

ListenerIgnoreError allows for ignoring all passed errors.

func ListenerShutdownTimeout

func ListenerShutdownTimeout(v time.Duration) ListenerOption

ListenerShutdownTimeout allows changing the default shutdown timeout.

func ListenerSkipErrors

func ListenerSkipErrors() ListenerOption

ListenerSkipErrors allows for ignoring all raised errors.

type MultiServerParams

type MultiServerParams struct {
	dig.In

	Logger  *zap.Logger
	Servers []Service `group:"services"`
}

MultiServerParams struct

type ServerResult

type ServerResult struct {
	dig.Out

	Server Service `group:"services"`
}

ServerResult struct

func NewAPIServer

func NewAPIServer(p APIParams) (ServerResult, error)

NewAPIServer creates api server by http.Handler from DI container

func NewGRPCServer

func NewGRPCServer(v *viper.Viper, key string, s *grpc.Server, l *zap.Logger) (ServerResult, error)

NewGRPCServer creates gRPC server that will be embedded info multi-server.

func NewHTTPServer

func NewHTTPServer(v *viper.Viper, key string, h http.Handler, l *zap.Logger) (ServerResult, error)

NewHTTPServer creates http-server that will be embedded into multi-server

type Service

type Service interface {
	Start() error
	Stop() error
}

Service interface that allows start and stop

func New

func New(log *zap.Logger, services ...Service) (Service, error)

New gets logger and services to create multiple service runner.

func NewGRPCService

func NewGRPCService(serve *grpc.Server, opts ...GRPCOption) (Service, error)

NewGRPCService creates gRPC service with passed gRPC options. If something went wrong it returns an error.

func NewHTTPService

func NewHTTPService(serve *http.Server, opts ...HTTPOption) (Service, error)

NewHTTPService creates Service from http.Server and HTTPOption's.

func NewListener

func NewListener(lis Listener, opts ...ListenerOption) (Service, error)

NewListener creates new Listener service and applies passed options to it.

func NewMultiServer

func NewMultiServer(p MultiServerParams) (Service, error)

NewMultiServer returns new multi servers group