xfasthttp

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() *Config
  • func RawConfig(key string) *Config
  • func StdConfig(name string) *Config
  • func (config *Config) Address() string
  • func (config *Config) Build() (*Server, error)
  • func (config *Config) MustBuild() *Server
  • func (config *Config) WithHost(host string) *Config
  • func (config *Config) WithLogger(logger *xlog.Logger) *Config
  • func (config *Config) WithPort(port int) *Config
• type Middleware
• type Server
  • func (s *Server) GracefulStop(ctx context.Context) error
  • func (s *Server) Healthz() bool
  • func (s *Server) Info() *server.ServiceInfo
  • func (s *Server) Serve() error
  • func (s *Server) Stop() error

Constants

const (
	// HeaderAcceptEncoding ...
	HeaderAcceptEncoding = "Accept-Encoding"
	// HeaderContentType ...
	HeaderContentType = "Content-Type"
	// HRPC Errord
	HeaderHRPCErr = "HRPC-Errord"
)

Headers

const (
	// MIMEApplicationJSON ...
	MIMEApplicationJSON = "application/json"
	// MIMEApplicationJSONCharsetUTF8 ...
	MIMEApplicationJSONCharsetUTF8 = MIMEApplicationJSON + "; " + charsetUTF8
	// MIMEApplicationProtobuf ...
	MIMEApplicationProtobuf = "application/protobuf"
)

MIME types

const ModName = "server.fasthttp"

ModName named a mod

Types

type Config

type Config struct {
	Host              string
	Port              int
	Deployment        string
	Debug             bool
	DisableMetric     bool
	DisableTrace      bool
	DisablePrintStack bool
	// ServiceAddress service address in registry info, default to 'Host:Port'
	ServiceAddress string
	CertFile       string
	PrivateFile    string
	EnableTLS      bool

	SlowQueryThresholdInMilli int64
	ReadBufferSize            int
	WriteBufferSize           int
	ReduceMemoryUsage         bool
	Concurrency               int
	// contains filtered or unexported fields
}

Config HTTP config

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig ...

func RawConfig

func RawConfig(key string) *Config

RawConfig ...

func StdConfig

func StdConfig(name string) *Config

StdConfig Sanchin Standard HTTP Server config

func (*Config) Address

func (config *Config) Address() string

Address ...

func (*Config) Build

func (config *Config) Build() (*Server, error)

Build create server instance, then initialize it with necessary interceptor

func (*Config) MustBuild

func (config *Config) MustBuild() *Server

func (*Config) WithHost

func (config *Config) WithHost(host string) *Config

WithHost ...

func (*Config) WithLogger

func (config *Config) WithLogger(logger *xlog.Logger) *Config

WithLogger ...

func (*Config) WithPort

func (config *Config) WithPort(port int) *Config

WithPort ...

type Middleware

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

type Server

type Server struct {
	*fasthttp.Server
	// contains filtered or unexported fields
}

Server ...

func (*Server) GracefulStop

func (s *Server) GracefulStop(ctx context.Context) error

GracefulStop implements server.Server interface it will stop echo server gracefully

func (*Server) Healthz

func (s *Server) Healthz() bool

func (*Server) Info

func (s *Server) Info() *server.ServiceInfo

Info returns server info, used by governor and consumer balancer

func (*Server) Serve

func (s *Server) Serve() error

Server implements server.Server interface.

func (*Server) Stop

func (s *Server) Stop() error

Stop implements server.Server interface it will terminate echo server immediately