middleware

Documentation

Index

• Constants
• type Cors
  • func NewCors(options Options) *Cors
  • func (cors *Cors) Invoke(c *web.Context, next web.HandlerFunc)
• type GzipMiddleware
  • func NewGzip(level int) *GzipMiddleware
  • func (h *GzipMiddleware) Invoke(c *web.Context, next web.HandlerFunc)
• type Health
  • func NewHealth() *Health
  • func (h *Health) Invoke(c *web.Context, next web.HandlerFunc)
• type Options
• type PPROF
  • func NewPPROF() *PPROF
  • func (p *PPROF) Invoke(c *web.Context, next web.HandlerFunc)
• type Static
  • func NewStatic(dir string) *Static
  • func (s *Static) Invoke(c *web.Context, next web.HandlerFunc)

Constants

const (
	BestCompression    = gzip.BestCompression
	BestSpeed          = gzip.BestSpeed
	DefaultCompression = gzip.DefaultCompression
	NoCompression      = gzip.NoCompression
)

These compression constants are copied from the compress/gzip package.

Types

type Cors

type Cors struct {
	// Debug logger
	Log *log.Logger
	// contains filtered or unexported fields
}

Cors http handler

func NewCors

func NewCors(options Options) *Cors

NewCors creates a new Cors handler with the provided options.

func (*Cors) Invoke

func (cors *Cors) Invoke(c *web.Context, next web.HandlerFunc)

Invoke funcion will be called by WebServer

type GzipMiddleware

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

GzipMiddleware struct is gzip middlware

func NewGzip

func NewGzip(level int) *GzipMiddleware

NewGzip returns a middleware which will handle the Gzip compression in Invoke. Valid values for level are identical to those in the compress/gzip package.

func (*GzipMiddleware) Invoke

func (h *GzipMiddleware) Invoke(c *web.Context, next web.HandlerFunc)

Invoke function is a middleware entry

type Health

type Health struct {
}

Health is health middleware struct

func NewHealth

func NewHealth() *Health

NewHealth returns Health middlware instance

func (*Health) Invoke

func (h *Health) Invoke(c *web.Context, next web.HandlerFunc)

Invoke function is a middleware entry

type Options

type Options struct {
	// AllowedOrigins is a list of origins a cross-domain request can be executed from.
	// If the special "*" value is present in the list, all origins will be allowed.
	// An origin may contain a wildcard (*) to replace 0 or more characters
	// (i.e.: http://*.domain.com). Usage of wildcards implies a small performance penality.
	// Only one wildcard can be used per origin.
	// Default value is ["*"]
	AllowedOrigins []string
	// AllowOriginFunc is a custom function to validate the origin. It take the origin
	// as argument and returns true if allowed or false otherwise. If this option is
	// set, the content of AllowedOrigins is ignored.
	AllowOriginFunc func(origin string) bool
	// AllowedMethods is a list of methods the client is allowed to use with
	// cross-domain requests. Default value is simple methods (GET and POST)
	AllowedMethods []string
	// AllowedHeaders is list of non simple headers the client is allowed to use with
	// cross-domain requests.
	// If the special "*" value is present in the list, all headers will be allowed.
	// Default value is [] but "Origin" is always appended to the list.
	AllowedHeaders []string
	// ExposedHeaders indicates which headers are safe to expose to the API of a CORS
	// API specification
	ExposedHeaders []string
	// AllowCredentials indicates whether the request can include user credentials like
	// cookies, HTTP authentication or client side SSL certificates.
	AllowCredentials bool
	// MaxAge indicates how long (in seconds) the results of a preflight request
	// can be cached
	MaxAge int
	// OptionsPassthrough instructs preflight to let other potential next handlers to
	// process the OPTIONS method. Turn this on if your application handles OPTIONS.
	OptionsPassthrough bool
	// Debugging flag adds additional output to debug server side CORS issues
	Debug bool
}

Options is a configuration container to setup the CORS middleware.

type PPROF

type PPROF struct {
}

PPROF is middleware struct

func NewPPROF

func NewPPROF() *PPROF

NewPPROF returns a mddleware instance

func (*PPROF) Invoke

func (p *PPROF) Invoke(c *web.Context, next web.HandlerFunc)

Invoke function is a middleware entry

type Static

type Static struct {
	// Dir is the directory to serve static files from
	Dir http.FileSystem
	// Prefix is the optional prefix used to serve the static directory content
	Prefix string
	// IndexFile defines which file to serve as index if it exists.
	IndexFile string
}

Static is a middleware handler that serves static files in the given directory/filesystem.

func NewStatic

func NewStatic(dir string) *Static

NewStatic returns a new instance of Static

func (*Static) Invoke

func (s *Static) Invoke(c *web.Context, next web.HandlerFunc)

Invoke function is a middleware entry