http

Documentation

Index

• Variables
• type ControllerConfig
• type Middleware
  • func NewMiddleware(conf MiddlewareConfig, lim domain.Limiter) *Middleware
  • func (m *Middleware) Chain(h http.Handler) http.Handler
• type MiddlewareConfig
• type Server
  • func NewServer(conf ServerConfig, middle func(http.Handler) http.Handler, ...) (*Server, error)
  • func (s *Server) Monitor(ctx context.Context)
  • func (s *Server) Start() error
• type ServerConfig

Variables

var (
	DefaultServerConfig = ServerConfig{
		Domain:          "",
		Host:            "localhost",
		Port:            "8001",
		H2C:             false,
		ReadTimeout:     5 * time.Second,
		WriteTimeout:    10 * time.Second,
		IdleTimeout:     10 * time.Second,
		ShutdownTimeout: 1 * time.Second,
		Controller:      DefaultControllerConfig,
	}
	DefaultMiddlewareConfig = MiddlewareConfig{
		CorsAllowOrigin: "",
		WriteTimeout:    10 * time.Second,
		MaxFileSize:     512 * kb,
		Debug:           false,
	}
	DefaultControllerConfig = ControllerConfig{
		MaxNumberOfFiles: 3,
		MaxFileSize:      512 * kb,
	}
)

var (
	ErrServerClosed = http.ErrServerClosed
)

Types

type ControllerConfig

type ControllerConfig struct {
	MaxNumberOfFiles int   `mapstructure:"CONTROLLER_MAX_NUMBER_OF_FILES" validate:"required"`
	MaxFileSize      int64 `mapstructure:"CONTROLLER_MAX_FILE_SIZE"       validate:"required"`
}

type Middleware

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

func NewMiddleware

func NewMiddleware(
	conf MiddlewareConfig,
	lim domain.Limiter,
) *Middleware

func (*Middleware) Chain

func (m *Middleware) Chain(h http.Handler) http.Handler

type MiddlewareConfig

type MiddlewareConfig struct {
	CorsAllowOrigin string        `mapstructure:"MIDDLEWARE_CORS_ALLOW_ORIGIN" validate:"required"`
	WriteTimeout    time.Duration `mapstructure:"SERVER_WRITE_TIMEOUT"         validate:"required"`
	MaxFileSize     int64         `mapstructure:"CONTROLLER_MAX_FILE_SIZE"     validate:"required"`
	Debug           bool          `mapstructure:"MIDDLEWARE_DEBUG"`
}

type Server

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

func NewServer

func NewServer(
	conf ServerConfig,
	middle func(http.Handler) http.Handler,
	serv domain.Servicer,
	serverWait chan<- error,
) (*Server, error)

func (*Server) Monitor

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

func (*Server) Start

func (s *Server) Start() error

type ServerConfig

type ServerConfig struct {
	Domain          string           `mapstructure:"SERVER_DOMAIN"`
	Host            string           `mapstructure:"SERVER_HOST"`
	Port            string           `mapstructure:"SERVER_PORT"             validate:"required"`
	H2C             bool             `mapstructure:"SERVER_H2C"`
	ReadTimeout     time.Duration    `mapstructure:"SERVER_READ_TIMEOUT"     validate:"required"`
	WriteTimeout    time.Duration    `mapstructure:"SERVER_WRITE_TIMEOUT"    validate:"required"`
	IdleTimeout     time.Duration    `mapstructure:"SERVER_IDLE_TIMEOUT"     validate:"required"`
	ShutdownTimeout time.Duration    `mapstructure:"SERVER_SHUTDOWN_TIMEOUT" validate:"required"`
	Controller      ControllerConfig `mapstructure:",squash"`
}