httpserver

README

httpserver HTTP服务器配置模块

提供HTTP服务器配置结构

Documentation

Index

• Variables
• func CreateRecoverMiddleware(logger *log.Logger, renderers []ErrorRenderer) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
• func MustListenAndServeHTTP(s *http.Server, config *httpservice.Config, app http.Handler)
• func PrivateRecoverMiddleware(logger *log.Logger) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
• func PrivateRefRenderer(w http.ResponseWriter, r *http.Request, err error) bool
• func RecoverMiddleware(logger *log.Logger) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
• func ShutdownHTTP(Server *http.Server)
• func ShutdownHTTPWithTimeout(Server *http.Server, Timeout time.Duration)
• func WithContextShutdown(ctx context.Context, Server *http.Server)
• type ErrorRenderer
• type PrivateRefError

Variables

var HeaderPanicID = "panic-id"

HeaderPanicID header for panic id.

var HeaderPrivateRef = "private-ref"

HeaderPrivateRef header for private ref.

var PrivateRenderers = []ErrorRenderer{
	PrivateRefRenderer,
}

PrivateRenderers private renders

Functions

func CreateRecoverMiddleware

func CreateRecoverMiddleware(logger *log.Logger, renderers []ErrorRenderer) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

CreateRecoverMiddleware create recover middleware by given logger and renders.

func MustListenAndServeHTTP

func MustListenAndServeHTTP(s *http.Server, config *httpservice.Config, app http.Handler)

MustListenAndServeHTTP listen and serve http server with given server,config and handler. Panic if any error raised.

func PrivateRecoverMiddleware

func PrivateRecoverMiddleware(logger *log.Logger) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

PrivateRecoverMiddleware create private recover middleware with given logger.

func PrivateRefRenderer

func PrivateRefRenderer(w http.ResponseWriter, r *http.Request, err error) bool

PrivateRefRenderer error private ref render

func RecoverMiddleware

func RecoverMiddleware(logger *log.Logger) func(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)

RecoverMiddleware create recover middleware with given logger.

func ShutdownHTTP

func ShutdownHTTP(Server *http.Server)

ShutdownHTTP shutdown http server.

func ShutdownHTTPWithTimeout

func ShutdownHTTPWithTimeout(Server *http.Server, Timeout time.Duration)

ShutdownHTTPWithTimeout shutdown http server ith given timeout.

func WithContextShutdown

func WithContextShutdown(ctx context.Context, Server *http.Server)

WithContextShutdown shutdown http server ith given context.

Types

type ErrorRenderer

type ErrorRenderer func(w http.ResponseWriter, r *http.Request, err error) bool

ErrorRenderer error http render. Return false if render finished.

type PrivateRefError

type PrivateRefError interface {
	//ErrorPrivateRef error private ref
	ErrorPrivateRef() string
}

PrivateRefError private ref error