api

Documentation

Index

• type Config
• type Option
  • func Log(opts ...log.ServerOption) Option
  • func WithAddr(addr string) Option
  • func WithConfig(config config.Config) Option
  • func WithDecodeRequestFunc(decReq engine.DecodeRequestFunc) Option
  • func WithEncodeErrorFunc(encErr engine.EncodeErrorFunc) Option
  • func WithEncodeResponseFunc(encResp engine.EncodeResponseFunc) Option
  • func WithEndHook(f engine.Hook) Option
  • func WithEngine(engine string) Option
  • func WithMaxHeaderBytes(maxHeaderBytes uint) Option
  • func WithReadHeaderTimeout(readHeaderTimeout uint) Option
  • func WithReadTimeout(readTimeout uint) Option
  • func WithServiceName(serviceName string) Option
  • func WithStartedHook(f engine.Hook) Option
  • func WithWriteTimeout(writeTimeout uint) Option
• type Server
  • func New(name string, opts ...Option) *Server
  • func (e *Server) Attempt() bool
  • func (e *Server) Config(cfg config.Config)
  • func (s *Server) Endpoint() *url.URL
  • func (e *Server) Group(group string, middlewares ...middleware.Middleware) *engine.RouterGroup
  • func (e *Server) Handle(path string, obj interface{}, opts ...engine.RouterOption)
  • func (e *Server) Name() string
  • func (e *Server) Options(opts ...Option)
  • func (s *Server) RouterPathList() []string
  • func (s *Server) ServiceName() string
  • func (e *Server) Start(ctx context.Context) (err error)
  • func (e *Server) Static(path, root string)
  • func (e *Server) StaticFile(path, filepath string)
  • func (e *Server) Stop(ctx context.Context) error
  • func (e *Server) Type() string
  • func (e *Server) Use(middlewares ...middleware.Middleware)
• type Static

Types

type Config

type Config struct {
	Addr              string        `json:"addr"`
	Engine            string        `json:"engine"`
	Status            engine.Status `json:"status"`
	ReadTimeout       uint          `json:"read_timeout"`
	WriteTimeout      uint          `json:"write_timeout"`
	ReadHeaderTimeout uint          `json:"read_header_timeout"`
	MaxHeaderBytes    uint          `json:"max_header_bytes"`
}

type Option

type Option func(*options)

Option 参数设置类型

func Log

func Log(opts ...log.ServerOption) Option

Log 设置日志配置

func WithAddr

func WithAddr(addr string) Option

WithAddr 设置服务地址

func WithConfig

func WithConfig(config config.Config) Option

WithStartedHook 设置启动回调函数

func WithDecodeRequestFunc

func WithDecodeRequestFunc(decReq engine.DecodeRequestFunc) Option

WithDecodeRequestFunc 解析入参

func WithEncodeErrorFunc

func WithEncodeErrorFunc(encErr engine.EncodeErrorFunc) Option

WithEncodeErrorFunc 编码错误

func WithEncodeResponseFunc

func WithEncodeResponseFunc(encResp engine.EncodeResponseFunc) Option

WithEncodeResponseFunc 编码响应

func WithEndHook

func WithEndHook(f engine.Hook) Option

func WithEngine

func WithEngine(engine string) Option

WithEngine 设置服务引擎（gin)

func WithMaxHeaderBytes

func WithMaxHeaderBytes(maxHeaderBytes uint) Option

WithMaxHeaderBytes 最大头部大小（http.DefaultMaxHeaderBytes untyped int = 1 << 20 )

func WithReadHeaderTimeout

func WithReadHeaderTimeout(readHeaderTimeout uint) Option

ReadHeaderTimeout 写入超时时间

func WithReadTimeout

func WithReadTimeout(readTimeout uint) Option

WithReadTimeout 读取超时时间

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceName 设置服务名称

func WithStartedHook

func WithStartedHook(f engine.Hook) Option

WithStartedHook 设置启动回调函数

func WithWriteTimeout

func WithWriteTimeout(writeTimeout uint) Option

WithWriteTimeout 写入超时时间

type Server

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

func New

func New(name string, opts ...Option) *Server

New 实例化

func (*Server) Attempt

func (e *Server) Attempt() bool

Attempt 判断是否可以启动

func (*Server) Config

func (e *Server) Config(cfg config.Config)

func (*Server) Endpoint

func (s *Server) Endpoint() *url.URL

http://127.0.0.1:8000

func (*Server) Group

func (e *Server) Group(group string, middlewares ...middleware.Middleware) *engine.RouterGroup

func (*Server) Handle

func (e *Server) Handle(path string, obj interface{}, opts ...engine.RouterOption)

func (*Server) Name

func (e *Server) Name() string

func (*Server) Options

func (e *Server) Options(opts ...Option)

Options 设置参数

func (*Server) RouterPathList

func (s *Server) RouterPathList() []string

获取树形的路径列表

func (*Server) ServiceName

func (s *Server) ServiceName() string

ServiceName 服务名称

func (*Server) Start

func (e *Server) Start(ctx context.Context) (err error)

Start 开始

func (*Server) Static

func (e *Server) Static(path, root string)

func (*Server) StaticFile

func (e *Server) StaticFile(path, filepath string)

func (*Server) Stop

func (e *Server) Stop(ctx context.Context) error

Shutdown 停止

func (*Server) Type

func (e *Server) Type() string

func (*Server) Use

func (e *Server) Use(middlewares ...middleware.Middleware)

type Static

type Static struct {
	RouterPath string
	FilePath   string
	IsFile     bool
}