Struct WsConnection

znet/ws_connection.go:26–113

WsConnection is a module for handling the read and write operations of a WebSocket connection. (Websocket连接模块, 用于处理 Websocket 连接的读写业务 一个连接对应一个Connection)

// WsConnection is a module for handling the read and write operations of a WebSocket connection.
// (Websocket连接模块, 用于处理 Websocket 连接的读写业务 一个连接对应一个Connection)
type WsConnection struct {
	// conn is the current connection's WebSocket socket TCP socket. (当前连接的socket TCP套接字)
	conn *websocket.Conn

	// connID is the current connection's ID, which can also be referred to as SessionID, and is globally unique.
	// uint64 range: 018,446,744,073,709,551,615
	// This is the maximum number of connIDs that the theory supports per process.
	// (当前连接的ID 也可以称作为SessionID，ID全局唯一 ，服务端Connection使用
	//  uint64 取值范围：0 ~ 18,446,744,073,709,551,615
	//  这个是理论支持的进程connID的最大数量)
	connID uint64

	// connection id for string
	// (字符串的连接id)
	connIdStr string

	// The workerid responsible for handling the link
	// 负责处理该连接的workerid
	workerID uint32

	// msgHandler is the message management module for MsgID and the corresponding message handling method.
	// (消息管理MsgID和对应处理方法的消息管理模块)
	msgHandler ziface.IMsgHandle

	// ctx and cancel are used to notify that the connection has exited/stopped.
	// (告知该连接已经退出/停止的channel)
	ctx    context.Context
	cancel context.CancelFunc

	// msgBuffChan is a buffered channel used for message communication between the read and write goroutines.
	// (有缓冲管道，用于读、写两个goroutine之间的消息通信)
	msgBuffChan chan []byte

	// msgLock is used for locking when users send and receive messages.
	// (用户收发消息的Lock)
	msgLock sync.Mutex

	// property is the connection attribute. (连接属性)
	property map[string]interface{}

	// propertyLock protects the current property lock. (保护当前property的锁)
	propertyLock sync.Mutex

	// isClosed is the current connection's closed state. (当前连接的关闭状态)
	isClosed bool

	// connManager is the Connection Manager to which the current connection belongs. (当前连接是属于哪个Connection Manager的)
	connManager ziface.IConnManager

	// onConnStart is the Hook function when the current connection is created.
	// (当前连接创建时Hook函数)
	onConnStart func(conn ziface.IConnection)

	// onConnStop is the Hook function when the current connection is disconnected.
	// (当前连接断开时的Hook函数)
	onConnStop func(conn ziface.IConnection)

	// packet is the data packet format.