handlers

Documentation

Overview

Package handlers contains the HTTP server along with the requests and routes. All HTTP related functions are in this package.

More info on: https://github.com/hunterlong/statping

Index

• func DesktopInit(ip string, port int)
• func ExecuteResponse(w http.ResponseWriter, r *http.Request, file string, data interface{}, ...)
• func IsAdmin(r *http.Request) bool
• func IsFullAuthenticated(r *http.Request) bool
• func IsReadAuthenticated(r *http.Request) bool
• func IsUser(r *http.Request) bool
• func Router() *mux.Router
• func RunHTTPServer(ip string, port int) error
• type Cacher
• type Item
  • func (item Item) Expired() bool
• type PluginSelect
• type Storage
  • func NewStorage() *Storage
  • func (s Storage) Delete(key string)
  • func (s Storage) Get(key string) []byte
  • func (s Storage) List() map[string]Item
  • func (s Storage) Set(key string, content []byte, duration time.Duration)

Functions

func DesktopInit

func DesktopInit(ip string, port int)

DesktopInit will run the Statping server on a specific IP and port using SQLite database

func ExecuteResponse

func ExecuteResponse(w http.ResponseWriter, r *http.Request, file string, data interface{}, redirect interface{})

ExecuteResponse will render a HTTP response for the front end user

func IsAdmin

func IsAdmin(r *http.Request) bool

IsAdmin returns true if the user session is an administrator

func IsFullAuthenticated

func IsFullAuthenticated(r *http.Request) bool

IsFullAuthenticated returns true if the HTTP request is authenticated. You can set the environment variable GO_ENV=test to bypass the admin authenticate to the dashboard features.

func IsReadAuthenticated

func IsReadAuthenticated(r *http.Request) bool

IsReadAuthenticated will allow Read Only authentication for some routes

func IsUser

func IsUser(r *http.Request) bool

IsUser returns true if the user is registered

func Router

func Router() *mux.Router

Router returns all of the routes used in Statping

func RunHTTPServer

func RunHTTPServer(ip string, port int) error

RunHTTPServer will start a HTTP server on a specific IP and port

Types

type Cacher

type Cacher interface {
	Get(key string) []byte
	Delete(key string)
	Set(key string, content []byte, duration time.Duration)
	List() map[string]Item
}

var CacheStorage Cacher

type Item

type Item struct {
	Content    []byte
	Expiration int64
}

Item is a cached reference

func (Item) Expired

func (item Item) Expired() bool

Expired returns true if the item has expired.

type PluginSelect

type PluginSelect struct {
	Plugin string
	Form   string
	Params map[string]interface{}
}

type Storage

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

Storage mecanism for caching strings in memory

func NewStorage

func NewStorage() *Storage

NewStorage creates a new in memory CacheStorage

func (Storage) Delete

func (s Storage) Delete(key string)

func (Storage) Get

func (s Storage) Get(key string) []byte

Get a cached content by key

func (Storage) List

func (s Storage) List() map[string]Item

func (Storage) Set

func (s Storage) Set(key string, content []byte, duration time.Duration)

Set a cached content by key