zhangdeman/websocket
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

调整注释

Browse Source
This commit is contained in:
白茶清欢
2021-06-05 22:13:09 +08:00
parent 0dc7b6fcdc
commit 58bb382499
11 changed files with 71 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
config/command.go
View File

@ -2,7 +2,7 @@
//
// Description : WS-Command 相关配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2021-04-17 2:34 下午
package config
@ -20,7 +20,7 @@ const (
// commandConfig 指令相关配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2:36 下午 2021/4/17
type CommandConfig struct {
@ -35,7 +35,7 @@ type SetCommandConfig func(cc *CommandConfig)
// ClosePushCommandErrorMessage 关闭指令执行异常时的消息推送
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2:51 下午 2021/4/17
func ClosePushCommandErrorMessage() SetCommandConfig {
@ -46,7 +46,7 @@ func ClosePushCommandErrorMessage() SetCommandConfig {
// CloseLogUpData 关闭记录上行数据
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:44 下午 2021/4/18
func CloseLogUpData() SetCommandConfig {
@ -57,7 +57,7 @@ func CloseLogUpData() SetCommandConfig {
// CloseLogDownData 关闭记录下行数据
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:45 下午 2021/4/18
func CloseLogDownData() SetCommandConfig {
@ -68,7 +68,7 @@ func CloseLogDownData() SetCommandConfig {
// CloseResponseData 关闭向客户端发送响应结果
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:47 下午 2021/4/18
func CloseResponseData() SetCommandConfig {
@ -79,7 +79,7 @@ func CloseResponseData() SetCommandConfig {
// NewCommandConfig 指令的配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2:39 下午 2021/4/17
func NewCommandConfig(optionFunc ...SetCommandConfig) *CommandConfig {

39
config/server.go
View File

@ -2,7 +2,7 @@
//
// Description : WS-Server 相关配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2021-04-17 2:32 下午
package config
@ -35,7 +35,7 @@ const (
// DefaultLogEnable 默认关闭日志
DefaultLogEnable = false
// DefaultLogConsole 默认开启控制台输出
DefaultLogConsole = true
DefaultLogConsole = false
// DefaultMode 默认为Debug模式
DefaultMode = RunModeDebug
// DefaultLogLevel 默认的日志级别
@ -60,7 +60,7 @@ const (
// WSServerConfig WS-Server的配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:02 下午 2021/4/17
type WSServerConfig struct {
@ -80,14 +80,14 @@ type WSServerConfig struct {
// SetWSServerConfig 设置WS-Server的配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:03 下午 2021/4/17
type SetWSServerConfig func(wsc *WSServerConfig)
// SetWSServerLogEnable 开启日志记录
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:25 下午 2021/4/17
func SetWSServerLogEnable(logPath string, logFile string, logLevel zapcore.Level, splitInterval logger.TimeIntervalType) SetWSServerConfig {
@ -112,9 +112,20 @@ func SetWSServerLogEnable(logPath string, logFile string, logLevel zapcore.Level
}
}
// EnableConsoleLog 开启控制台日志输出
//
// Author : zhangdeman001@ke.com<白茶清欢>
//
// Date : 11:25 下午 2021/4/22
func EnableConsoleLog() SetWSServerConfig {
return func(wsc *WSServerConfig) {
wsc.LogConsole = true
}
}
// EnablePprof 开启PProf,由于多模块共享一个进程,任意一个模块开启,就认为是开启
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 11:24 下午 2021/4/18
func EnablePprof(pprofPort int) SetWSServerConfig {
@ -126,7 +137,7 @@ func EnablePprof(pprofPort int) SetWSServerConfig {
// DisableStoreConnection 禁用连接存储
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 11:10 下午 2021/4/17
func DisableStoreConnection() SetWSServerConfig {
@ -137,7 +148,7 @@ func DisableStoreConnection() SetWSServerConfig {
// SetConnectionManager 连接管理实例
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 10:48 下午 2021/4/22
func SetConnectionManager(manager storage.IConnection) SetWSServerConfig {
@ -151,7 +162,7 @@ func SetConnectionManager(manager storage.IConnection) SetWSServerConfig {
// SetMaxMessageSize 限制消息大小
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 9:29 下午 2021/4/22
func SetMaxMessageSize(maxMessageSize int64) SetWSServerConfig {
@ -165,7 +176,7 @@ func SetMaxMessageSize(maxMessageSize int64) SetWSServerConfig {
// SetMaxMessageBufferSize 设置消息缓冲区
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 9:39 下午 2021/4/22
func SetMaxMessageBufferSize(maxMessageBufferSize int) SetWSServerConfig {
@ -179,7 +190,7 @@ func SetMaxMessageBufferSize(maxMessageBufferSize int) SetWSServerConfig {
// SetWriteWait 设置消息写入的等待时间, 单位 : 秒
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 9:44 下午 2021/4/22
func SetWriteWait(writeWaitTime int) SetWSServerConfig {
@ -193,7 +204,7 @@ func SetWriteWait(writeWaitTime int) SetWSServerConfig {
// SetPongWait 设置探活时,等待响应时间,单位 : 秒
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 9:55 下午 2021/4/22
func SetPongWait(pongWait int) SetWSServerConfig {
@ -207,7 +218,7 @@ func SetPongWait(pongWait int) SetWSServerConfig {
// SetPingPeriod 设置探活时间间隔
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 10:00 下午 2021/4/22
func SetPingPeriod(pingPeriod int) SetWSServerConfig {
@ -221,7 +232,7 @@ func SetPingPeriod(pingPeriod int) SetWSServerConfig {
// NewWSServerConfig 生成新的WS-Server配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:21 下午 2021/4/17
func NewWSServerConfig(optionList ...SetWSServerConfig) *WSServerConfig {