server

Documentation

Index

• Variables
• func ApisHandler(c *gin.Context)
• func CaptchaHandler() gin.HandlerFunc
• func CounterMiddleware() gin.HandlerFunc
• func ErrorPage(fsys fs.FS, msg string, err error) string
• func ErrorTmpl(fsys fs.FS, msg string, err error) string
• func Etag(str string, weak bool) string
• func FAQPage(fsys fs.FS) string
• func FooterPage(fsys fs.FS) string
• func GinHandlerFunc(hdlr http.HandlerFunc) gin.HandlerFunc
• func HeaderMiddleware(webServer srvConfig.WebServer) gin.HandlerFunc
• func HeaderPage(fsys fs.FS) string
• func InitServer(webServer srvConfig.WebServer)
• func ParseTmpl(tdir, tmpl string, data interface{}) (string, error)
• func Router(routes []Route, fsys fs.FS, static string, webServer srvConfig.WebServer) *gin.Engine
• func StartServer(r *gin.Engine, webServer srvConfig.WebServer)
• func SuccessTmpl(fsys fs.FS, msg string) string
• func TmplPage(fsys fs.FS, tmpl string, tmplData TmplRecord) string
• type GinRoute
• type Mem
• type Memory
• type Route
• type Templates
  • func (q Templates) TextTmpl(fsys fs.FS, tfile string, tmplData map[string]interface{}) string
  • func (q Templates) Tmpl(fsys fs.FS, tfile string, tmplData map[string]interface{}) string
• type TmplRecord
  • func MakeTmpl(fsys fs.FS, title string) TmplRecord
  • func MetricsPage(fsys fs.FS) TmplRecord
  • func (t TmplRecord) GetBytes(key string) []byte
  • func (t TmplRecord) GetElapsedTime() string
  • func (t TmplRecord) GetError() string
  • func (t TmplRecord) GetInt(key string) int
  • func (t TmplRecord) GetString(key string) string

Variables

var LimiterMiddleware gin.HandlerFunc

LimiterMiddleware provides limiter middleware pointer

var Time0 time.Time

Time0 represents initial time when we started the server

var TotalDeleteRequests uint64

TotalDeleteRequests counts total number of DELETE requests received by the server

var TotalGetRequests uint64

TotalGetRequests counts total number of GET requests received by the server

var TotalPostRequests uint64

TotalPostRequests counts total number of POST requests received by the server

var TotalPutRequests uint64

TotalPutRequests counts total number of PUT requests received by the server

Functions

func ApisHandler

func ApisHandler(c *gin.Context)

ApisHandler provides JSON output for server routes

func CaptchaHandler

func CaptchaHandler() gin.HandlerFunc

CaptchaHandler provides access to captcha server

func CounterMiddleware

func CounterMiddleware() gin.HandlerFunc

CounterMiddleware counts GET/POST/PUT/DELETE requests

func ErrorPage

func ErrorPage(fsys fs.FS, msg string, err error) string

ErrorPage returns error page

func ErrorTmpl

func ErrorTmpl(fsys fs.FS, msg string, err error) string

ErrorTmpl provides error template message

func Etag

func Etag(str string, weak bool) string

Generates an Etag for given string, provided by https://github.com/amalfra/etag

func FAQPage

func FAQPage(fsys fs.FS) string

FAQPage provides FAQ page

func FooterPage

func FooterPage(fsys fs.FS) string

FooterPage returns footer page

func GinHandlerFunc

func GinHandlerFunc(hdlr http.HandlerFunc) gin.HandlerFunc

GinHandlerFunc converts given http.Handler to gin.HandlerFunc

func HeaderMiddleware

func HeaderMiddleware(webServer srvConfig.WebServer) gin.HandlerFunc

HeaderMiddleware represents header middleware

func HeaderPage

func HeaderPage(fsys fs.FS) string

HeaderPage returns header page

func InitServer

func InitServer(webServer srvConfig.WebServer)

InitServer provides server initialization

func ParseTmpl

func ParseTmpl(tdir, tmpl string, data interface{}) (string, error)

ParseTmpl parses template with given data

func Router

func Router(routes []Route, fsys fs.FS, static string, webServer srvConfig.WebServer) *gin.Engine

Router provids server router, it takes two maps: one for non-authorized routes and anotehr for authorized ones

func StartServer

func StartServer(r *gin.Engine, webServer srvConfig.WebServer)

StartServer starts HTTP(s) server

func SuccessTmpl

func SuccessTmpl(fsys fs.FS, msg string) string

SuccessTmpl provides success template message

func TmplPage

func TmplPage(fsys fs.FS, tmpl string, tmplData TmplRecord) string

TmplPage parses given template and return HTML page

Types

type GinRoute

type GinRoute struct {
	Method string `json:"method"`
	Path   string `json:"path"`
}

GinRoute represents git route info

type Mem

type Mem struct {
	Virtual Memory
	Swap    Memory
}

Mem structure keeps track of virtual/swap memory of the server

type Memory

type Memory struct {
	Total       uint64  `json:"total"`
	Free        uint64  `json:"free"`
	Used        uint64  `json:"used"`
	UsedPercent float64 `json:"usedPercent"`
}

Memory structure keeps track of server memory

type Route

type Route struct {
	Method     string
	Path       string
	Scope      string
	Authorized bool
	Handler    gin.HandlerFunc
}

Route represents routes structure

type Templates

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

Templates structure

func (Templates) TextTmpl

func (q Templates) TextTmpl(fsys fs.FS, tfile string, tmplData map[string]interface{}) string

Tmpl method for ServerTemplates structure

func (Templates) Tmpl

func (q Templates) Tmpl(fsys fs.FS, tfile string, tmplData map[string]interface{}) string

Tmpl method for ServerTemplates structure

type TmplRecord

type TmplRecord map[string]interface{}

TmplRecord represent template record

func MakeTmpl

func MakeTmpl(fsys fs.FS, title string) TmplRecord

helper function to make initial template struct

func MetricsPage

func MetricsPage(fsys fs.FS) TmplRecord

MetricsPage represents metrics page

func (TmplRecord) GetBytes

func (t TmplRecord) GetBytes(key string) []byte

GetBytes returns bytes object for given key

func (TmplRecord) GetElapsedTime

func (t TmplRecord) GetElapsedTime() string

GetElapsedTime returns elapsed time

func (TmplRecord) GetError

func (t TmplRecord) GetError() string

GetError returns error string

func (TmplRecord) GetInt

func (t TmplRecord) GetInt(key string) int

GetInt converts given value for provided key to int data-type

func (TmplRecord) GetString

func (t TmplRecord) GetString(key string) string

GetString converts given value for provided key to string data-type