gramework

package module

Go to main page

Versions in this module

v1

v1.8.0

Oct 2, 2022

v1.7.1

Oct 14, 2021

Changes in this version

+ func SetInternalLogger(log log.Interface)

v1.7.0

Jun 28, 2019

Changes in this version

+ func OptKeepHijackedConns(keep bool) func(*App)

+ func OptUseCustomLogger(logger *log.Logger) func(*App)

type App

+ DefaultCacheOptions *CacheOptions

+ TLSPort uint16

+ func (app *App) Behind(u Behind)

+ func (app *App) SetSanitizerPolicy(newPolicy *bluemonday.Policy)

+ type Behind interface

+ RemoteAddr func(ctx *Context) net.Addr

+ RemoteIP func(ctx *Context) net.IP

+ type CacheOptions struct

+ CacheKey func(ctx *Context) []byte

+ Cacheable func(ctx *Context) bool

+ CacheableHeaders []string

+ NonCacheableHeaders []string

+ ReadCache func(ctx *Context, key []byte) ([]byte, bool)

+ StoreCache func(ctx *Context, key, value []byte, ttl time.Duration)

+ TTL time.Duration

type Context

+ func (ctx *Context) RemoteAddr() net.Addr

+ func (ctx *Context) RemoteIP() net.IP

+ func (ctx *Context) Sanitize(s string) string

+ func (ctx *Context) Sanitizer() *bluemonday.Policy

+ func (ctx *Context) Write(p []byte) (int, error)

v1.7.0-rc3

Jun 28, 2019

v1.7.0-rc2

Feb 3, 2019

v1.7.0-rc1

Jan 30, 2019

v1.6.2

Jan 30, 2019

v1.6.1

Jan 3, 2019

v1.6.0

Dec 25, 2018

v1.5.4

Jan 30, 2019

v1.5.4-rc1

Dec 19, 2018

v1.5.3

Dec 18, 2018

v1.5.2

Dec 12, 2018

v1.5.1

Nov 22, 2018

v1.5.0

Nov 6, 2018

v1.4.2

Nov 5, 2018

v1.4.1

Oct 26, 2018

v1.4.0

Oct 26, 2018

Changes in this version

+ const DefaultAppName

+ func OptAppName(n string) func(*App)

v1.3.2

Oct 24, 2018

Changes in this version

type SubRouter

+ func (r *SubRouter) Handle(method, route string, handler interface{}) *SubRouter

v1.3.1

Oct 19, 2018

v1.3.0

Oct 14, 2018

v1.2.3

Oct 12, 2018

Changes in this version

+ type JSON string

v1.2.2

Oct 10, 2018

Changes in this version

type App

+ func (app *App) SetCookiePath(path string)

v1.2.1

Oct 10, 2018

Changes in this version

type App

+ func (app *App) SetCookieExpire(d time.Duration)

v1.2.0

Oct 5, 2018

Changes in this version

+ func TicksPerSecond() int64

+ type HTML string

v1.1.0

Aug 30, 2018

Changes in this version

+ const ContextKey

+ var ErrInvalidGQLRequest = errors.New("invalid gql request")

+ func BytesToString(b []byte) string

+ func DefaultPanicHandler(ctx *Context, panicReason interface{})

+ func DisableFlags()

+ func OptMaxRequestBodySize(new int) func(*App)

+ func OptUseServer(s *fasthttp.Server) func(*App)

+ func SetEnv(e Environment)

+ func StringToBytes(s string) []byte

type App

+ NoDefaultPanicHandler bool

+ PanicHandlerCustomLayout string

+ PanicHandlerNoPoweredBy bool

+ func (app *App) Blacklist(ip net.IP) (ok bool)

+ func (app *App) GetStringFlag(name string) (string, bool)

+ func (app *App) MaxHackAttempts(attempts int32) (oldValue int32)

+ func (app *App) Protect(endpointPrefix string)

+ func (app *App) SetCookieDomain(domain string)

+ func (app *App) SetName(name string)

+ func (app *App) Shutdown() (err error)

+ func (app *App) Suspect(ip net.IP) (ok bool)

+ func (app *App) Untrust(ip net.IP) (ok bool)

+ func (app *App) Whitelist(ip net.IP) (ok bool)

+ type Auth struct

+ func (a *Auth) GetLogin() (string, error)

+ func (a *Auth) GetPass() (string, error)

type Context

+ func ContextFromValue(ctx context.Context) *Context

+ func (ctx *Context) Auth() *Auth

+ func (ctx *Context) BadRequest(err ...error)

+ func (ctx *Context) Blacklist() (ok bool)

+ func (ctx *Context) CSV(v interface{}) error

+ func (ctx *Context) ContentType() string

+ func (ctx *Context) DecodeGQL() (r *GQLRequest, err error)

+ func (ctx *Context) Encode(v interface{}) (sentType string, err error)

+ func (ctx *Context) GetCookieDomain() (domain string, wasConfigured bool)

+ func (ctx *Context) HackAttemptDetected()

+ func (ctx *Context) IsBlacklisted() (isBlacklisted bool)

+ func (ctx *Context) IsSuspect() (isSuspect bool)

+ func (ctx *Context) IsWhitelisted() (isWhitelisted bool)

+ func (ctx *Context) MWKill()

+ func (ctx *Context) RequestID() string

+ func (ctx *Context) SubPrefixes() []string

+ func (ctx *Context) Suspect() (ok bool)

+ func (ctx *Context) SuspectsHackAttempts() (attempts int32)

+ func (ctx *Context) ToCSV(v interface{}) (b []byte, err error)

+ func (ctx *Context) ToContext(parentCtx ...context.Context) context.Context

+ func (ctx *Context) ToXML(v interface{}) ([]byte, error)

+ func (ctx *Context) Untrust() (ok bool)

+ func (ctx *Context) Whitelist() (ok bool)

+ func (ctx *Context) XML(v interface{}) error

+ type Environment int32

+ const DEV

+ const PROD

+ const STAGE

+ func GetEnv() Environment

+ func (e Environment) String() string

+ type FastHTTPLoggerAdapter struct

+ func NewFastHTTPLoggerAdapter(logger *log.Interface) (fasthttplogger *FastHTTPLoggerAdapter)

+ func (l *FastHTTPLoggerAdapter) Printf(msg string, v ...interface{})

+ type GQLRequest struct

+ OperationName string

+ Query string

+ Variables map[string]interface{}

v1.0.0

Aug 15, 2017

Changes in this version

+ const CONNECT

+ const DELETE

+ const GET

+ const HEAD

+ const HeaderAllow

+ const MethodDELETE

+ const MethodGET

+ const MethodHEAD

+ const MethodOPTIONS

+ const MethodPATCH

+ const MethodPOST

+ const MethodPUT

+ const OPTIONS

+ const PATCH

+ const POST

+ const PUT

+ const PathAny

+ const PathSlash

+ const PathSlashAny

+ const Slash

+ const Version

+ var DefaultContentType = []byte("text/plain; charset=utf-8")

+ var ErrArgNotFound = errors.New("undefined argument")

+ var ErrEmptyMiddleware = errors.New("can't use nil middleware")

+ var ErrTLSNoEmails = errors.New("auto tls: no emails provided")

+ var ErrUnsupportedMiddlewareType = errors.New("unsupported middleware type")

+ var Logger = &log.Logger

+ var QuestionMark = []byte("?")

+ var SlashByte = byte('/')

+ func CleanPath(p string) string

+ func Errorf(msg string, v ...interface{})

+ func Nanotime() int64

+ func UnJSONBytes(b []byte, v ...interface{}) (interface{}, error)

+ type App struct

+ EnableFirewall bool

+ Flags *Flags

+ HandleUnknownDomains bool

+ Logger log.Interface

+ Settings Settings

+ TLSEmails []string

+ func New() *App

+ func (app *App) AddFlag(f Flag)

+ func (app *App) CORSMiddleware() func(*Context)

+ func (app *App) DELETE(route string, handler interface{}) *App

+ func (app *App) Domain(domain string) *Router

+ func (app *App) Forbidden(ctx *Context)

+ func (app *App) GET(route string, handler interface{}) *App

+ func (app *App) HEAD(route string, handler interface{}) *App

+ func (app *App) HTTP() *Router

+ func (app *App) HTTPS() *Router

+ func (app *App) Handle(method, route string, handler interface{}) *App

+ func (app *App) HandleMethodNotAllowed(newValue bool) (oldValue bool)

+ func (app *App) HandleOPTIONS(newValue bool) (oldValue bool)

+ func (app *App) Health()

+ func (app *App) HealthHandler(ctx *Context)

+ func (app *App) JSON(route string, handler interface{}) *App

+ func (app *App) ListenAndServe(addr ...string) error

+ func (app *App) ListenAndServeAll(httpAddr ...string)

+ func (app *App) ListenAndServeAllDev(httpAddr ...string)

+ func (app *App) ListenAndServeAutoTLS(addr string, cachePath ...string) error

+ func (app *App) ListenAndServeAutoTLSDev(addr string, cachePath ...string) error

+ func (app *App) MethodNotAllowed(c func(ctx *Context)) *App

+ func (app *App) NotFound(notFoundHandler func(*Context)) *App

+ func (app *App) OPTIONS(route string, handler interface{}) *App

+ func (app *App) PATCH(route string, handler interface{}) *App

+ func (app *App) POST(route string, handler interface{}) *App

+ func (app *App) PUT(route string, handler interface{}) *App

+ func (app *App) PanicHandler(panicHandler func(*Context, interface{})) *App

+ func (app *App) Redir(url string) func(*Context)

+ func (app *App) RegFlags()

+ func (app *App) SPAIndex(path string) *Router

+ func (app *App) Serve(ln net.Listener) error

+ func (app *App) ServeDir(path string) func(*Context)

+ func (app *App) ServeDirCustom(path string, stripSlashes int, compress bool, generateIndexPages bool, ...) func(*Context)

+ func (app *App) ServeDirNoCache(path string) func(*Context)

+ func (app *App) ServeDirNoCacheCustom(path string, stripSlashes int, compress bool, generateIndexPages bool, ...) func(*Context)

+ func (app *App) ServeFile(route, file string) *Router

+ func (app *App) ServeInfrastructure(i *infrastructure.Infrastructure)

+ func (app *App) Sub(path string) *SubRouter

+ func (app *App) ToTLSHandler() func(*Context)

+ func (app *App) Use(middleware interface{}) error

+ func (app *App) UseAfterRequest(middleware interface{}) error

+ func (app *App) UsePre(middleware interface{}) error

+ type Context struct

+ App *App

+ Cookies Cookies

+ Logger log.Interface

+ func (c *Context) CORS() *Context

+ func (c *Context) Err500(message ...interface{}) *Context

+ func (c *Context) Forbidden()

+ func (c *Context) GETKeys() []string

+ func (c *Context) GETKeysBytes() [][]byte

+ func (c *Context) GETParam(argName string) []string

+ func (c *Context) GETParams() map[string][]string

+ func (c *Context) HTML() *Context

+ func (c *Context) JSON(v interface{}) error

+ func (c *Context) JSONError(v interface{}) error

+ func (c *Context) RouteArg(argName string) string

+ func (c *Context) RouteArgErr(argName string) (string, error)

+ func (c *Context) ToJSON(v interface{}) ([]byte, error)

+ func (c *Context) ToTLS()

+ func (c *Context) UnJSON(v interface{}) error

+ func (c *Context) UnJSONBytes(b []byte, v ...interface{}) (interface{}, error)

+ func (c *Context) Writef(format string, a ...interface{})

+ func (c *Context) Writeln(a ...interface{})

+ func (ctx *Context) LogHeaders()

+ func (ctx *Context) Proxy(url string) error

+ type Cookies struct

+ Mu sync.RWMutex

+ Storage map[string]string

+ func (c *Cookies) Exists(key string) bool

+ func (c *Cookies) Get(key string) (string, bool)

+ func (c *Cookies) Set(key, value string)

+ type FirewallSettings struct

+ BlockTimeout int64

+ MaxReqPerMin int64

+ type Flag struct

+ Default string

+ Description string

+ Name string

+ Value *string

+ type Flags struct

+ type RequestHandler func(*Context)

+ func NewGrameHandler(h http.Handler) RequestHandler

+ func NewGrameHandlerFunc(h http.HandlerFunc) RequestHandler

+ type RequestHandlerErr func(*Context) error

+ type Router struct

+ func (r *Router) Allowed(path, reqMethod string) (allow string)

+ func (r *Router) DELETE(route string, handler interface{}) *Router

+ func (r *Router) Forbidden(ctx *Context)

+ func (r *Router) GET(route string, handler interface{}) *Router

+ func (r *Router) HEAD(route string, handler interface{}) *Router

+ func (r *Router) HTTP() *Router

+ func (r *Router) HTTPS() *Router

+ func (r *Router) Handle(method, route string, handler interface{}) *Router

+ func (r *Router) HandleMethodNotAllowed(newValue bool) (oldValue bool)

+ func (r *Router) HandleOPTIONS(newValue bool) (oldValue bool)

+ func (r *Router) Handler() func(*Context)

+ func (r *Router) JSON(route string, handler interface{}) *Router

+ func (r *Router) Lookup(method, path string, ctx *Context) (RequestHandler, bool)

+ func (r *Router) MethodNotAllowed(c func(ctx *Context))

+ func (r *Router) NotFound(notFoundHandler func(*Context))

+ func (r *Router) OPTIONS(route string, handler interface{}) *Router

+ func (r *Router) PATCH(route string, handler interface{}) *Router

+ func (r *Router) POST(route string, handler interface{}) *Router

+ func (r *Router) PUT(route string, handler interface{}) *Router

+ func (r *Router) PanicHandler(panicHandler func(*Context, interface{}))

+ func (r *Router) Redir(route, url string)

+ func (r *Router) SPAIndex(path string) *Router

+ func (r *Router) ServeFile(route, file string) *Router

+ func (r *Router) ServeFiles(path string, rootPath string)

+ func (r *Router) Sub(path string) *SubRouter

+ type Settings struct

+ Firewall FirewallSettings

+ type SubRouter struct

+ func (r *SubRouter) DELETE(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) Forbidden(ctx *Context)

+ func (r *SubRouter) GET(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) HEAD(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) HTTP() *SubRouter

+ func (r *SubRouter) HTTPS() *SubRouter

+ func (r *SubRouter) JSON(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) OPTIONS(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) PATCH(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) POST(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) PUT(route string, handler interface{}) *SubRouter

+ func (r *SubRouter) Redir(route, url string)

+ func (r *SubRouter) ServeFile(route, file string) *SubRouter

+ func (r *SubRouter) Sub(path string) *SubRouter

+ func (r *SubRouter) ToTLSHandler() func(*Context)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL