websocket_utils

package
v1.1.15 Latest Latest
Warning

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

Go to latest
Published: Jul 15, 2025 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var WSServer = websocket.Upgrader{
	CheckOrigin: func(r *http.Request) bool {

		return true
	},
}

WSServer 全局WebSocket升级器

Functions

This section is empty.

Types

type WebSocket

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

func NewWebSocketByDial added in v1.0.5

func NewWebSocketByDial(url string, requestHeader http.Header) (*WebSocket, error)

NewWebSocketByDial 主动建立连接

func NewWebSocketByUpgrade added in v1.0.5

func NewWebSocketByUpgrade(w http.ResponseWriter, r *http.Request, responseHeader http.Header) (*WebSocket, error)

NewWebSocketByUpgrade 升级HTTP连接

func (*WebSocket) Close

func (ws *WebSocket) Close()

Close 安全关闭连接

func (*WebSocket) Done

func (ws *WebSocket) Done() <-chan struct{}

Done 获取关闭信号通道

func (*WebSocket) IsClosed added in v1.1.0

func (ws *WebSocket) IsClosed() bool

IsClosed 检查连接是否已关闭

func (*WebSocket) LocalAddr added in v1.1.0

func (ws *WebSocket) LocalAddr() string

LocalAddr 获取本地地址

func (*WebSocket) OnMessage

func (ws *WebSocket) OnMessage(handleFunc func(messageType int, payload []byte)) error

OnMessage 持续处理消息

func (*WebSocket) RemoteAddr added in v1.1.0

func (ws *WebSocket) RemoteAddr() string

RemoteAddr 获取对端地址

func (*WebSocket) SendMessage

func (ws *WebSocket) SendMessage(messageType int, payload []byte) error

SendMessage 线程安全的消息发送

func (*WebSocket) SetLogger added in v1.1.0

func (ws *WebSocket) SetLogger(logger *log.Logger)

SetLogger 设置自定义日志记录器

func (*WebSocket) SetReadTimeout added in v1.1.0

func (ws *WebSocket) SetReadTimeout(timeout time.Duration)

SetReadTimeout 设置读取超时

func (*WebSocket) StartHeartbeat added in v1.1.9

func (ws *WebSocket) StartHeartbeat(interval time.Duration)

StartHeartbeat 启动心跳机制

func (*WebSocket) StopHeartbeat added in v1.1.9

func (ws *WebSocket) StopHeartbeat()

StopHeartbeat 停止心跳机制

Jump to

Keyboard shortcuts

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