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

10
abstract/ICommand.go
View File

@ -2,7 +2,7 @@
//
// Description : 长连接命令的约束
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2021-03-27 6:34 下午
package abstract
@ -14,25 +14,25 @@ import (
// ICommand 指令
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:35 下午 2021/3/27
type ICommand interface {
// GetCommand 注册的客户端指令
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:21 下午 2021/3/27
GetCommand() string
// GetConfigOption 获取指令的配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2:49 下午 2021/4/17
GetConfigOption() []config.SetCommandConfig
// Execute 执行指令的逻辑
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:21 下午 2021/3/27
Execute(ctx *context.WSContext, data []byte) (interface{}, error)

20
abstract/IWebsocket.go
View File

@ -2,7 +2,7 @@
//
// Description : 长连接模块的基础约束
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2021-03-27 6:32 下午
package abstract
@ -14,56 +14,56 @@ import (
// IWebsocket 接口约束
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:35 下午 2021/3/27
type IWebsocket interface {
// Connect 建立连接时,处理的方法
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:39 下午 2021/3/27
Connect(ctx *context.WSContext) error
// Disconnect 断开连接时处理的方法
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:40 下午 2021/3/27
Disconnect(ctx *context.WSContext)
// Close 关闭连接
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 8:43 下午 2021/3/27
Close(ctx *context.WSContext, code int, message string) error
// HandshakeURL 注册的websocket路由
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:45 下午 2021/3/27
HandshakeURL() []string
// GetCommandList 注册长连接模块支持的命令
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:48 下午 2021/3/27
GetCommandList() []ICommand
// GetModuleFlag 获取模块标识,全局唯一
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:50 下午 2021/3/27
GetModuleFlag() string
// GetServerPort 获取长连接监听的端口,多个模块可监听不同的端口
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 6:55 下午 2021/3/27
GetServerPort() int
// GetWSServerConfig 获取WS-Server的配置
//
// Author : go_developer@163.com<张德满>
// Author : go_developer@163.com<白茶清欢>
//
// Date : 7:01 下午 2021/4/17
GetWSServerConfig() []config.SetWSServerConfig