From 9dc73bf281b495434eebb34e28d95284238cc04a Mon Sep 17 00:00:00 2001
From: kercylan98 <kercylan@gmail.com>
Date: Tue, 11 Jul 2023 10:25:55 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20server=20=E5=8C=85=E6=B3=A8=E9=87=8A?=
 =?UTF-8?q?=E5=AE=8C=E5=96=84?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 server/conn_packet.go   | 7 ++++---
 server/conn_readonly.go | 6 ++++++
 server/cross.go         | 1 +
 server/message.go       | 5 +++--
 server/packet.go        | 5 +++--
 server/server.go        | 6 +++---
 6 files changed, 20 insertions(+), 10 deletions(-)

diff --git a/server/conn_packet.go b/server/conn_packet.go
index 0244517..0087d53 100644
--- a/server/conn_packet.go
+++ b/server/conn_packet.go
@@ -1,7 +1,8 @@
 package server
 
+// connPacket 连接包
 type connPacket struct {
-	websocketMessageType int
-	packet               []byte
-	callback             func(err error)
+	websocketMessageType int             // websocket 消息类型
+	packet               []byte          // 数据包
+	callback             func(err error) // 回调函数
 }
diff --git a/server/conn_readonly.go b/server/conn_readonly.go
index 3a88ed2..2f2d003 100644
--- a/server/conn_readonly.go
+++ b/server/conn_readonly.go
@@ -4,10 +4,16 @@ import (
 	"net"
 )
 
+// ConnReadonly 连接只读接口
 type ConnReadonly interface {
+	// RemoteAddr 获取远程地址
 	RemoteAddr() net.Addr
+	// GetID 获取连接 ID
 	GetID() string
+	// GetIP 获取连接 IP
 	GetIP() string
+	// GetData 获取连接数据
 	GetData(key any) any
+	// IsWebsocket 是否是 websocket 连接
 	IsWebsocket() bool
 }
diff --git a/server/cross.go b/server/cross.go
index bafdc85..346e520 100644
--- a/server/cross.go
+++ b/server/cross.go
@@ -1,5 +1,6 @@
 package server
 
+// Cross 跨服接口
 type Cross interface {
 	// Init 初始化跨服
 	//  - serverId: 本服id
diff --git a/server/message.go b/server/message.go
index 924b635..293991d 100644
--- a/server/message.go
+++ b/server/message.go
@@ -55,9 +55,10 @@ func (slf MessageErrorAction) String() string {
 	return messageErrorActionNames[slf]
 }
 
+// Message 服务器消息
 type Message struct {
-	t     MessageType
-	attrs []any
+	t     MessageType // 消息类型
+	attrs []any       // 消息属性
 }
 
 func (slf *Message) String() string {
diff --git a/server/packet.go b/server/packet.go
index b863c0f..1046d0c 100644
--- a/server/packet.go
+++ b/server/packet.go
@@ -1,8 +1,9 @@
 package server
 
+// Packet 数据包
 type Packet struct {
-	WebsocketType int
-	Data          []byte
+	WebsocketType int    // websocket 消息类型
+	Data          []byte // 数据
 }
 
 func (slf Packet) String() string {
diff --git a/server/server.go b/server/server.go
index d778c10..bcc1654 100644
--- a/server/server.go
+++ b/server/server.go
@@ -401,7 +401,7 @@ func (slf *Server) shutdown(err error, stack ...string) {
 		if slf.multiple != nil {
 			slf.multiple.RegExitEvent(func() {
 				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 {
 				if server.addr == slf.addr {
@@ -411,11 +411,11 @@ func (slf *Server) shutdown(err error, stack ...string) {
 			}
 		} else {
 			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 {
 		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 {
 		slf.closeChannel <- struct{}{}