server

Documentation

Index

• type Options
• type Route
• type Server
  • func New(logger *lecho.Logger, opts Options) (*Server, error)
  • func (s *Server) Router() *echo.Echo
  • func (s *Server) Run(port uint64) error

Types

type Options

type Options struct {
	// RequestLimit is a number of requests per second for each IP.
	// If value is 0, rate limit is disabled.
	RequestLimit uint64

	// RequestLimitTimeWindow is a period of requests limit in seconds.
	// If value is 0, rate limit is set default value.
	RequestLimitTimeWindow uint64

	// BodyLimit is a maximum size of request body.
	// If value is 0, body limit is disabled.
	BodyLimit uint64
}

Options is a set of options for server.

type Route

type Route interface {
	Use(e *echo.Echo)
}

type Server

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

Server is HTTP server that wraps Ferret worker.

func New

func New(logger *lecho.Logger, opts Options) (*Server, error)

func (*Server) Router

func (s *Server) Router() *echo.Echo

func (*Server) Run

func (s *Server) Run(port uint64) error

Run start server that serve at the given port.

Port should not begin with ":".