http

Documentation

Index

• type Option
  • func WithDebug(isDebug bool) Option
  • func WithMetrics(uri string) Option
  • func WithMiddleware(middleware ...gin.HandlerFunc) Option
  • func WithOnShutDown(onShutdown []func()) Option
  • func WithPprof(pprofTurn bool) Option
  • func WithReadTimeout(timeout time.Duration) Option
  • func WithWriteTimeout(timeout time.Duration) Option
• type RegisterRouter
• type Server
  • func New(addr string, router RegisterRouter, opts ...Option) *Server
  • func (s *Server) Close() (err error)
  • func (s *Server) Start() (err error)

Types

type Option

type Option func(s *Server)

func WithDebug

func WithDebug(isDebug bool) Option

func WithMetrics

func WithMetrics(uri string) Option

func WithMiddleware

func WithMiddleware(middleware ...gin.HandlerFunc) Option

func WithOnShutDown

func WithOnShutDown(onShutdown []func()) Option

func WithPprof

func WithPprof(pprofTurn bool) Option

func WithReadTimeout

func WithReadTimeout(timeout time.Duration) Option

func WithWriteTimeout

func WithWriteTimeout(timeout time.Duration) Option

type RegisterRouter

type RegisterRouter func(server *gin.Engine)

type Server

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

func New

func New(addr string, router RegisterRouter, opts ...Option) *Server

func (*Server) Close

func (s *Server) Close() (err error)

func (*Server) Start

func (s *Server) Start() (err error)