docs: server 包注释完善

This commit is contained in:
kercylan98 2023-07-11 10:25:55 +08:00
parent 74c8f215d7
commit 9dc73bf281
6 changed files with 20 additions and 10 deletions

View File

@ -1,7 +1,8 @@
package server package server
// connPacket 连接包
type connPacket struct { type connPacket struct {
websocketMessageType int websocketMessageType int // websocket 消息类型
packet []byte packet []byte // 数据包
callback func(err error) callback func(err error) // 回调函数
} }

View File

@ -4,10 +4,16 @@ import (
"net" "net"
) )
// ConnReadonly 连接只读接口
type ConnReadonly interface { type ConnReadonly interface {
// RemoteAddr 获取远程地址
RemoteAddr() net.Addr RemoteAddr() net.Addr
// GetID 获取连接 ID
GetID() string GetID() string
// GetIP 获取连接 IP
GetIP() string GetIP() string
// GetData 获取连接数据
GetData(key any) any GetData(key any) any
// IsWebsocket 是否是 websocket 连接
IsWebsocket() bool IsWebsocket() bool
} }

View File

@ -1,5 +1,6 @@
package server package server
// Cross 跨服接口
type Cross interface { type Cross interface {
// Init 初始化跨服 // Init 初始化跨服
// - serverId: 本服id // - serverId: 本服id

View File

@ -55,9 +55,10 @@ func (slf MessageErrorAction) String() string {
return messageErrorActionNames[slf] return messageErrorActionNames[slf]
} }
// Message 服务器消息
type Message struct { type Message struct {
t MessageType t MessageType // 消息类型
attrs []any attrs []any // 消息属性
} }
func (slf *Message) String() string { func (slf *Message) String() string {

View File

@ -1,8 +1,9 @@
package server package server
// Packet 数据包
type Packet struct { type Packet struct {
WebsocketType int WebsocketType int // websocket 消息类型
Data []byte Data []byte // 数据
} }
func (slf Packet) String() string { func (slf Packet) String() string {

View File

@ -401,7 +401,7 @@ func (slf *Server) shutdown(err error, stack ...string) {
if slf.multiple != nil { if slf.multiple != nil {
slf.multiple.RegExitEvent(func() { slf.multiple.RegExitEvent(func() {
log.ErrorWithStack("Server", s, zap.Any("network", slf.network), zap.String("listen", slf.addr), log.ErrorWithStack("Server", s, zap.Any("network", slf.network), zap.String("listen", slf.addr),
zap.String("action", "Shutdown"), zap.String("state", "exception"), zap.Error(err)) zap.String("action", "shutdown"), zap.String("state", "exception"), zap.Error(err))
}) })
for i, server := range slf.multiple.servers { for i, server := range slf.multiple.servers {
if server.addr == slf.addr { if server.addr == slf.addr {
@ -411,11 +411,11 @@ func (slf *Server) shutdown(err error, stack ...string) {
} }
} else { } else {
log.ErrorWithStack("Server", s, zap.Any("network", slf.network), zap.String("listen", slf.addr), log.ErrorWithStack("Server", s, zap.Any("network", slf.network), zap.String("listen", slf.addr),
zap.String("action", "Shutdown"), zap.String("state", "exception"), zap.Error(err)) zap.String("action", "shutdown"), zap.String("state", "exception"), zap.Error(err))
} }
} else { } else {
log.Info("Server", zap.Any("network", slf.network), zap.String("listen", slf.addr), log.Info("Server", zap.Any("network", slf.network), zap.String("listen", slf.addr),
zap.String("action", "Shutdown"), zap.String("state", "normal")) zap.String("action", "shutdown"), zap.String("state", "normal"))
} }
if slf.gServer == nil { if slf.gServer == nil {
slf.closeChannel <- struct{}{} slf.closeChannel <- struct{}{}