server

Documentation

Index

• func IsEnabled(cfg *Config) bool
• func UserAgent(cfg *Config) string
• type Config
• type Server
  • func NewServer(svc string, srv Serverer, logger *zap.Logger, sh fx.Shutdowner) *Server
  • func (s *Server) Start()
  • func (s *Server) Stop(ctx context.Context)
• type Serverer

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for server.

func UserAgent

func UserAgent(cfg *Config) string

UserAgent for server.

Types

type Config

type Config struct {
	Security  *security.Config `yaml:"security,omitempty" json:"security,omitempty" toml:"security,omitempty"`
	Port      string           `yaml:"port,omitempty" json:"port,omitempty" toml:"port,omitempty"`
	Retry     *retry.Config    `yaml:"retry,omitempty" json:"retry,omitempty" toml:"retry,omitempty"`
	UserAgent string           `yaml:"user_agent,omitempty" json:"user_agent,omitempty" toml:"user_agent,omitempty"`
}

Config for server.

type Server

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

Server is a generic server.

func NewServer

func NewServer(svc string, srv Serverer, logger *zap.Logger, sh fx.Shutdowner) *Server

NewServer that can start and stop an underlying server.

func (*Server) Start

func (s *Server) Start()

Start the server.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context)

Stop the server.

type Serverer

type Serverer interface {
	fmt.Stringer

	// IsEnabled the underlying server.
	IsEnabled() bool

	// Serve the underlying server.
	Serve() error

	// Shutdown the underlying server.
	Shutdown(ctx context.Context) error
}

Serverer allows transports to create their own.