gin

package
v0.0.0-...-04e6e7a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 22, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	Host                string // 服务ip
	Port                int    // 服务端口
	Mode                string // 运行模式
	PlainTextAddress    string // 注册中心显示地址
	Version             string // 当前项目版本号
	Name                string // 服务名称
	ServerSlowThreshold int64  // 服务器超时阈值
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig 默认配置

func RawConfig

func RawConfig(key string) *Config

RawConfig 读取配置

func ScanConfig

func ScanConfig(name string) *Config

ScanConfig 从config组件读取配置

func (*Config) Address

func (c *Config) Address() string

Address 获取服务地址

func (*Config) Build

func (c *Config) Build() *Server

Build 构建gin的服务

func (*Config) WithHost

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

WithHost 设置主机名

func (*Config) WithLogger

func (c *Config) WithLogger(log *logger.Logger) *Config

WithLogger 重新设置日志

func (*Config) WithPort

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

WithPort 设置端口

type Context

type Context = gin.Context

type RouterDesc

type RouterDesc struct {
	Path    string
	Method  string
	Handler methodHandler
}

RouterDesc 路由描述

type Server

type Server struct {
	*gin.Engine
	Server *http.Server

	Config *Config
	// contains filtered or unexported fields
}

func (*Server) Info

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

Info 获取服务信息

func (*Server) RegisterService

func (s *Server) RegisterService(sd *ServiceDesc, ss interface{})

RegisterService 注册服务

func (*Server) Start

func (s *Server) Start() error

Start 启动服务

func (*Server) Stop

func (s *Server) Stop() error

Stop 停止服务

func (*Server) Upgrade

func (s *Server) Upgrade(ws *WebSocket) gin.IRoutes

Upgrade 升级协议为websocket

type ServiceDesc

type ServiceDesc struct {
	ServiceName string       // 服务名称
	HandlerType interface{}  // 服务类型
	Routers     []RouterDesc // 路由描述
}

ServiceDesc 服务描述

type WebSocket

type WebSocket struct {
	Pattern string
	Handler WebSocketFunc
	*websocket.Upgrader
	Header http.Header
}

WebSocket ..

func WebSocketOptions

func WebSocketOptions(pattern string, handler WebSocketFunc, opts ...WebSocketOption) *WebSocket

WebSocketOptions ..

func (*WebSocket) Upgrade

func (ws *WebSocket) Upgrade(w http.ResponseWriter, r *http.Request)

Upgrade get upgrage request

type WebSocketConn

type WebSocketConn interface {
	Subprotocol() string
	Close() error
	LocalAddr() net.Addr
	RemoteAddr() net.Addr
	WriteControl(messageType int, data []byte, deadline time.Time) error
	NextWriter(messageType int) (io.WriteCloser, error)
	WritePreparedMessage(pm *websocket.PreparedMessage) error
	WriteMessage(messageType int, data []byte) error
	SetWriteDeadline(t time.Time) error
	NextReader() (messageType int, r io.Reader, err error)
	ReadMessage() (messageType int, p []byte, err error)
	SetReadDeadline(t time.Time) error
	SetReadLimit(limit int64)
	CloseHandler() func(code int, text string) error
	SetCloseHandler(h func(code int, text string) error)
	PingHandler() func(appData string) error
	SetPingHandler(h func(appData string) error)
	PongHandler() func(appData string) error
	SetPongHandler(h func(appData string) error)
	UnderlyingConn() net.Conn
	EnableWriteCompression(enable bool)
	SetCompressionLevel(level int) error
}

WebSocketConn websocket conn, see websocket.Conn

type WebSocketFunc

type WebSocketFunc func(WebSocketConn, error)

WebSocketFunc ..

type WebSocketOption

type WebSocketOption func(*WebSocket)

WebSocketOption ..

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL