ws

package

v0.3.1 Latest Latest Go to latest Published: Jun 7, 2025 License: MIT Imports: 13 Imported by: 0

Details

This section is empty.

This section is empty.

func BytesToString(b []byte) string

BytesToString 转换 []byte 到 string，不会分配新的内存

func Metrics(w http.ResponseWriter)

Metrics 返回 Hub 的当前的关键指标

func SendMessage(clientId string, msgType message.Type, msg string) error

func StringToBytes(s string) []byte

StringToBytes 转换 string 到 []byte，不会分配新的内存

func WebsocketServe(writer http.ResponseWriter, request *http.Request)

WebsocketServe 处理 WebSocket 连接请求

type Authenticator interface {
	// Authenticate 验证请求是否合法，第一个返回值为用户 id，第二个返回值为错误
	Authenticate(r *http.Request) (map[string]interface{}, error)
}

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

Client 是一个中间人，负责 WebSocket 连接和 Hub 之间的通信

type Handler func(msg message.WsMessage, err error)

Handler 错误处理函数

type Hub struct {

	// 互斥锁，保护 userClients 以及 clients 的读写
	sync.RWMutex
	// contains filtered or unexported fields
}

Hub 维护了所有的客户端连接

var HubBus *Hub

func NewHub() *Hub

func (h *Hub) Run()

Run 注册、取消注册请求处理

func (h *Hub) SetMessageHandler(handler MessageHandler)

type JWTAuthenticator struct{}

func (J *JWTAuthenticator) Authenticate(r *http.Request) (map[string]interface{}, error)

type MessageHandler interface {
	Handler(clientId, userId, userType string, messageType int, message []byte) error
}

MessageHandler 消息处理器

Path	Synopsis
message