internal

Documentation

Index

• type Error
• type Server
  • func (s *Server) Start()
• type ServerInfo
• type StatusError
  • func (se StatusError) Error() string
  • func (se StatusError) Status() int

Types

type Error

type Error interface {
	error
	Status() int
}

Error represents a handler error. It provides methods for a HTTP status code and embeds the built-in error interface.

type Server

type Server struct {
	LogFile         string
	Port            int `valid:"range(1|65535)~'port' must be a valid port between 1-65535, required~Port must be specified"`
	Router          *httprouter.Router
	MaxShutdownTime time.Duration
	Info            ServerInfo
	IsHealthy       int32
	Verbose         bool
}

Server describes the server configuration

func (*Server) Start

func (s *Server) Start()

Start initializes a server instance and start the server

type ServerInfo

type ServerInfo struct {
	Version string
	Commit  string
	Date    string
	BuiltBy string
}

ServerInfo contains some metadata about the server

type StatusError

type StatusError struct {
	Code int
	Err  error
}

StatusError represents an error with an associated HTTP status code.

func (StatusError) Error

func (se StatusError) Error() string

Allows StatusError to satisfy the error interface.

func (StatusError) Status

func (se StatusError) Status() int

Status returns our HTTP status code.