websocket

Documentation

Index

• type ClientConn
  • func NewClient(url, protocol, origin string) (*ClientConn, error)
  • func (c *ClientConn) Close() error
  • func (c *ClientConn) Die(msg string)
  • func (c *ClientConn) Read(v []byte) (n int, err error)
  • func (c *ClientConn) ReadJSON(v any) error
  • func (c *ClientConn) Write(p []byte) (n int, err error)
  • func (c *ClientConn) WriteJSON(v any) error
• type Message
  • func (m *Message) GetPayload(v any) error
• type ServerConfig
  • func (c *ServerConfig) CheckOrigin(origin string) bool
  • func (c *ServerConfig) CorsMiddleware() gin.HandlerFunc
  • func (c *ServerConfig) Handler(handler func(*ServerConn)) gin.HandlerFunc
• type ServerConn
  • func (c *ServerConn) Close() error
  • func (c *ServerConn) Die(msg string)
  • func (c *ServerConn) Read(v []byte) (n int, err error)
  • func (c *ServerConn) ReadJSON(v any) error
  • func (c *ServerConn) Write(p []byte) (n int, err error)
  • func (c *ServerConn) WriteJSON(v any) error

Types

type ClientConn

type ClientConn struct {
	*websocket.Conn
}

ClientConn WebSocket 客户端连接

func NewClient

func NewClient(url, protocol, origin string) (*ClientConn, error)

NewClient 创建 WebSocket 客户端连接

func (*ClientConn) Close

func (c *ClientConn) Close() error

Close 关闭连接，忽略 EOF 错误

func (*ClientConn) Die

func (c *ClientConn) Die(msg string)

Die 发送消息并关闭连接

func (*ClientConn) Read

func (c *ClientConn) Read(v []byte) (n int, err error)

Read 读取数据（实现 io.Reader 接口，流式读取）

func (*ClientConn) ReadJSON

func (c *ClientConn) ReadJSON(v any) error

ReadJSON 读取 JSON 消息

func (*ClientConn) Write

func (c *ClientConn) Write(p []byte) (n int, err error)

Write 写入数据（实现 io.Writer 接口，流式写入）

func (*ClientConn) WriteJSON

func (c *ClientConn) WriteJSON(v any) error

WriteJSON 写入 JSON 消息

type Message

type Message struct {
	Method  string `json:"method"`
	TaskID  uint   `json:"taskId"`
	Success bool   `json:"success"`
	Message string `json:"message"`
	Payload any    `json:"payload"`
}

Message WebSocket 消息结构

func (*Message) GetPayload

func (m *Message) GetPayload(v any) error

GetPayload 解析 Payload 到目标类型

type ServerConfig

type ServerConfig struct {
	AllowedOrigins []string // 允许的 Origin 列表，支持通配符 *
}

ServerConfig WebSocket 服务端配置

func (*ServerConfig) CheckOrigin

func (c *ServerConfig) CheckOrigin(origin string) bool

CheckOrigin 检查 Origin 是否允许

func (*ServerConfig) CorsMiddleware

func (c *ServerConfig) CorsMiddleware() gin.HandlerFunc

CorsMiddleware CORS 中间件

func (*ServerConfig) Handler

func (c *ServerConfig) Handler(handler func(*ServerConn)) gin.HandlerFunc

Handler 创建 WebSocket 处理器（gin HandlerFunc） 使用方式：router.GET("/ws", config.Handler(func(conn *ServerConn) { ... }))

type ServerConn

type ServerConn struct {
	*websocket.Conn
}

ServerConn WebSocket 服务端连接

func (*ServerConn) Close

func (c *ServerConn) Close() error

Close 关闭连接，忽略 EOF 错误

func (*ServerConn) Die

func (c *ServerConn) Die(msg string)

Die 发送消息并关闭连接

func (*ServerConn) Read

func (c *ServerConn) Read(v []byte) (n int, err error)

Read 读取数据（实现 io.Reader 接口，流式读取）

func (*ServerConn) ReadJSON

func (c *ServerConn) ReadJSON(v any) error

ReadJSON 读取 JSON 消息

func (*ServerConn) Write

func (c *ServerConn) Write(p []byte) (n int, err error)

Write 写入数据（实现 io.Writer 接口，流式写入）

func (*ServerConn) WriteJSON

func (c *ServerConn) WriteJSON(v any) error

WriteJSON 写入 JSON 消息