Documentation
¶
Index ¶
- Variables
- type Client
- type Option
- func Addr(addr string) Option
- func MaxConnections(max int) Option
- func MaxMessageSize(size int64) Option
- func Pattern(pattern string) Option
- func PingInterval(interval time.Duration) Option
- func ReadTimeout(timeout time.Duration) Option
- func SSL(certFile, keyFile string) Option
- func WriteQueueSize(size int) Option
- func WriteTimeout(timeout time.Duration) Option
- type Options
- type Server
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrInvalidOpCode 无效的操作码错误 // 当收到的WebSocket帧的操作码不符合规范时返回 ErrInvalidOpCode = errors.New("invalid opcode") // ErrInvalidState 无效的连接状态错误 // 当连接处于非法状态时返回 ErrInvalidState = errors.New("invalid state") // ErrHubClosed Hub已关闭错误 // 当尝试向已关闭的Hub分配新连接时返回 ErrHubClosed = errors.New("hub closed") // ErrWriteQueueFull 写入队列已满错误 // 当消息写入队列达到容量上限时返回,通常是因为发送速度跟不上接收速度 ErrWriteQueueFull = errors.New("write queue full") // ErrMaxConns 连接数达到上限错误 // 当尝试建立新连接但已达到最大连接限制时返回 ErrMaxConns = errors.New("max connections reached") )
WebSocket错误定义 定义了WebSocket实现中可能返回的各种错误类型
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Options)
Option 定义选项函数类型 用于配置Options结构体
func PingInterval ¶
PingInterval 设置心跳间隔时间 设置0则默认为2秒
type Options ¶
type Options struct {
// Addr 监听地址
// 使用 Start() 启动时有效, HandleRequest() 时无效
Addr string
// Pattern 监听路径
// 使用 Start() 启动时有效, HandleRequest() 时无效
Pattern string
// 证书文件
CertFile string
// 秘钥文件
KeyFile string
// MaxMessageSize 最大消息大小
// 0表示不限制
// 建议根据应用的消息大小调整此参数,防止内存溢出
MaxMessageSize int64
// WriteQueueSize 写入队列的大小
// 增大队列可以提高写入吞吐量,但会增加内存使用
// 适合高频、低延迟场景的优化参数
WriteQueueSize int
// ReadTimeout 读取超时时间
// 0表示不超时
// 建议设置合理的超时,避免空闲连接占用资源
ReadTimeout time.Duration
// WriteTimeout 写入超时时间
// 0表示不超时
// 建议设置合理的超时,避免网络阻塞
WriteTimeout time.Duration
// MaxConnections 最大并发连接数
// 0表示无限制
// 限制并发连接数可以防止资源耗尽
MaxConnections int
// PingInterval 心跳间隔时间
// 0表示不启用心跳
// 建议设置合理的心跳间隔,避免连接断开
PingInterval time.Duration
// PongTimeout 心跳响应超时时间
// 0表示不超时
// 建议设置合理的超时,避免连接断开
PongTimeout time.Duration
// contains filtered or unexported fields
}
Options 定义WebSocket服务器的配置选项 使用选项模式允许灵活配置服务器参数 所有参数都有合理的默认值,适合游戏等高频场景
Click to show internal directories.
Click to hide internal directories.