websocket

Documentation

Overview

Package websocket SDK 需要实现的 websocket 定义。

Index

• Variables
• func PanicHandler(e interface{}, session *dto.Session)
• func Register(ws WebSocket)
• func RegisterHandlers(handlers ...interface{}) dto.Intent
• func RegisterResumeSignal(signal syscall.Signal)
• type WebSocket

Variables

var PanicBufLen = 1024

PanicBufLen Panic 堆栈大小

Functions

func PanicHandler

func PanicHandler(e interface{}, session *dto.Session)

PanicHandler 处理websocket场景的 panic ，打印堆栈

func Register

func Register(ws WebSocket)

Register 注册 websocket 实现

func RegisterHandlers

func RegisterHandlers(handlers ...interface{}) dto.Intent

RegisterHandlers 兼容老版本的注册方式

func RegisterResumeSignal

func RegisterResumeSignal(signal syscall.Signal)

RegisterResumeSignal 注册用于通知 client 将连接进行 resume 的信号

Types

type WebSocket

type WebSocket interface {
	// New 创建一个新的ws实例，需要传递 session 对象
	New(session dto.Session) WebSocket
	// Connect 连接到 wss 地址
	Connect() error
	// Identify 鉴权连接
	Identify() error
	// Session 拉取 session 信息，包括 token，shard，seq 等
	Session() *dto.Session
	// Resume 重连
	Resume() error
	// Listening 监听websocket事件
	Listening() error
	// Write 发送数据
	Write(message *dto.WSPayload) error
	// Close 关闭连接
	Close()
}

WebSocket 需要实现的接口

var (
	// ClientImpl websocket 实现
	ClientImpl WebSocket
	// ResumeSignal 用于强制 resume 连接的信号量
	ResumeSignal syscall.Signal
)