server

Documentation

Index

• type HTTPServerConfiguration
  • func (h *HTTPServerConfiguration) LoadFromEnvVars() error
• type Server
  • func NewServer(log logging.Logger, configuration HTTPServerConfiguration) *Server
  • func (s Server) NamespaceValidation() gin.HandlerFunc
  • func (s *Server) Run(ctx context.Context)
  • func (s *Server) RunSecurely(ctx context.Context)

Types

type HTTPServerConfiguration

type HTTPServerConfiguration struct {
	Host               string        `envconfig:"HTTP_HOST" default:""`
	Port               int           `envconfig:"HTTP_PORT" default:"80"`
	RequestTimeout     time.Duration `envconfig:"HTTP_REQUEST_TIMEOUT" default:"30s"`
	UserID             string        `envconfig:"USER_ID" required:"true"`
	CertificateFile    string        `envconfig:"CERTIFICATE_FILE" default:"/etc/tls/tls.crt"`
	CertificateKeyFile string        `envconfig:"CERTIFICATE_KEY_FILE" default:"/etc/tls/tls.key"`
}

HTTPServerConfiguration is a struct that holds all the environment variables required to the HTTP server

func (*HTTPServerConfiguration) LoadFromEnvVars

func (h *HTTPServerConfiguration) LoadFromEnvVars() error

LoadFromEnvVars reads all env vars required for the server package

type Server

type Server struct {
	Router *gin.Engine
	// contains filtered or unexported fields
}

Server defines a struct for server

func NewServer

func NewServer(log logging.Logger, configuration HTTPServerConfiguration) *Server

NewServer initializes a server

func (Server) NamespaceValidation

func (s Server) NamespaceValidation() gin.HandlerFunc

NamespaceValidation checks if namespace is in the query params

func (*Server) Run

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

Run when called starts the server

func (*Server) RunSecurely

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

RunSecurely when called starts the https server