webServer

Documentation

Index

• Constants
• type FastHttpServer
  • func NewLocalServer() *FastHttpServer
  • func (s *FastHttpServer) AddMiddlewareSetToSet(mwSet MiddlewareSet, name string)
  • func (s *FastHttpServer) AddMiddlewareToSet(m Middleware, name string)
  • func (s *FastHttpServer) EraseMiddlewares()
  • func (s *FastHttpServer) GetMiddlewareSet(name string) MiddlewareSet
  • func (s *FastHttpServer) ListMiddlewareNames() []string
  • func (s *FastHttpServer) Start() appError.Typ
  • func (s *FastHttpServer) WithMiddlewareSet(name string, handler fasthttp.RequestHandler) fasthttp.RequestHandler
• type Middleware
• type MiddlewareSet

Constants

const (
	StateNotStarted        = "NotStarted"
	StateStarted           = "Started"
	StateShutdownRequested = "ShutdownRequested"
	StateShutdownCompleted = "ShutdownCompleted"
)

Types

type FastHttpServer

type FastHttpServer struct {
	Name         string // Name of the server  (used to identify it against another one, in case it is needed)
	Router       *router.Router
	Server       fasthttp.Server
	BindPort     int
	EnableIpv6   bool
	BlockOnStart bool // Should we block on start or not
	// contains filtered or unexported fields
}

func NewLocalServer

func NewLocalServer() *FastHttpServer

NewLocalServer creates a basic new local server and returns it. It can then be modified and started (or started as it is)

func (*FastHttpServer) AddMiddlewareSetToSet

func (s *FastHttpServer) AddMiddlewareSetToSet(mwSet MiddlewareSet, name string)

AddMiddlewareSetToSet adds all the middlewares of one set to another set. Useful when you want to have some base middleware sets and you want to create others with those middlewares as common with the new ones

func (*FastHttpServer) AddMiddlewareToSet

func (s *FastHttpServer) AddMiddlewareToSet(m Middleware, name string)

AddMiddlewareToSet will add a middleware to a single middleware set of a given name If a middleware set of that name does not exist, then one will be created.

func (*FastHttpServer) EraseMiddlewares

func (s *FastHttpServer) EraseMiddlewares()

EraseMiddlewares removes all the middlewares from the server so that you can create a whole new set from scratch

func (*FastHttpServer) GetMiddlewareSet

func (s *FastHttpServer) GetMiddlewareSet(name string) MiddlewareSet

GetMiddlewareSet returns the middleware set by the given name. If there is no middleware set by that name, a blank one is returned instead

func (*FastHttpServer) ListMiddlewareNames

func (s *FastHttpServer) ListMiddlewareNames() []string

ListMiddlewareNames is supposed to return the list of middlewares in the server

func (*FastHttpServer) Start

func (s *FastHttpServer) Start() appError.Typ

Start starts the web server according to given parameters

func (*FastHttpServer) WithMiddlewareSet

func (s *FastHttpServer) WithMiddlewareSet(name string, handler fasthttp.RequestHandler) fasthttp.RequestHandler

WithMiddlewareSet will return a request handler which would contain all the middlewares given by name applied to the handler supplied to this function.

type Middleware

type Middleware func(handler fasthttp.RequestHandler) fasthttp.RequestHandler

type MiddlewareSet

type MiddlewareSet []Middleware