server

Documentation

Overview

Package server 提供基于 gin 的 HTTP 服务启动、信号处理与优雅关闭能力。

Index

• type Option
  • func WithShutdownTimeout(d time.Duration) Option
• type Server
  • func New(cfg config.ServerConfig, handler *gin.Engine, log logger.Logger, ...) *Server
  • func (s *Server) Run()

Types

type Option

type Option func(*Server)

Option Server 可选配置。

func WithShutdownTimeout

func WithShutdownTimeout(d time.Duration) Option

WithShutdownTimeout 设置优雅关闭超时时间，默认 5s。

type Server

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

Server HTTP 服务。

func New

func New(cfg config.ServerConfig, handler *gin.Engine, log logger.Logger, opts ...Option) *Server

New 创建 HTTP 服务。

func (*Server) Run

func (s *Server) Run()

Run 启动服务并阻塞，直到收到 SIGINT 或 SIGTERM 后优雅关闭。