config

Documentation

Overview

Package config ...

Description : WS-Command 相关配置

Author : go_developer@163.com<白茶清欢>

Date : 2021-04-17 2:34 下午

Package config ...

Description : WS-Server 相关配置

Author : go_developer@163.com<白茶清欢>

Date : 2021-04-17 2:32 下午

Index

• Constants
• type CommandConfig
  • func NewCommandConfig(optionFunc ...SetCommandConfig) *CommandConfig
• type SetCommandConfig
  • func CloseLogDownData() SetCommandConfig
  • func CloseLogUpData() SetCommandConfig
  • func ClosePushCommandErrorMessage() SetCommandConfig
  • func CloseResponseData() SetCommandConfig
• type SetWSServerConfig
  • func DisableStoreConnection() SetWSServerConfig
  • func EnableConsoleLog() SetWSServerConfig
  • func EnablePprof(pprofPort int) SetWSServerConfig
  • func SetConnectionManager(manager storage.IConnection) SetWSServerConfig
  • func SetMaxMessageBufferSize(maxMessageBufferSize int) SetWSServerConfig
  • func SetMaxMessageSize(maxMessageSize int64) SetWSServerConfig
  • func SetPingPeriod(pingPeriod int) SetWSServerConfig
  • func SetPongWait(pongWait int) SetWSServerConfig
  • func SetWSServerLogEnable(logPath string, logFile string, logLevel zapcore.Level, ...) SetWSServerConfig
  • func SetWriteWait(writeWaitTime int) SetWSServerConfig
• type WSServerConfig
  • func NewWSServerConfig(optionList ...SetWSServerConfig) *WSServerConfig

Constants

const (
	// DefaultPushMessageWithError 默认开启异常消息推送
	DefaultPushMessageWithError = true
	// DefaultLogUpData 默认开记录上行数据
	DefaultLogUpData = true
	// DefaultLogDownData 默认开启记录下行数据
	DefaultLogDownData = true
	// DefaultResponseData 默认开启向客户端响应数据
	DefaultResponseData = true
)

const (
	// RunModeProduct 生产环境
	RunModeProduct = "product"
	// RunModeDebug debug环境
	RunModeDebug = "debug"
)

const (
	// LogSplitIntervalHour 按小时切割日志
	LogSplitIntervalHour = "hour"
	// LogSplitIntervalDay 按天切割日志
	LogSplitIntervalDay = "day"
)

const (
	// DefaultLogEnable 默认关闭日志
	DefaultLogEnable = false
	// DefaultLogConsole 默认开启控制台输出
	DefaultLogConsole = false
	// DefaultMode 默认为Debug模式
	DefaultMode = RunModeDebug
	// DefaultLogLevel 默认的日志级别
	DefaultLogLevel = zapcore.DebugLevel
	// DefaultLogSplitInterval 默认的日志切割时间
	DefaultLogSplitInterval = consts.LogSplitHour
	// DefaultStoreConnection 默认存储连接
	DefaultStoreConnection = true
	// DefaultEnablePprof 默认关闭pprof
	DefaultEnablePprof = false
	// DefaultMaxMessageSize 默认的最大消息大小
	DefaultMaxMessageSize = 4096
	// DefaultMaxMessageBufferSize 默认的消息缓冲区大小
	DefaultMaxMessageBufferSize = 8192
	// DefaultWriteWait 默认的消息写入等待时间
	DefaultWriteWait = 10
	// DefaultPongWait 默认的等待响应时间
	DefaultPongWait = 10
	// DefaultPingPeriod 多久探活一次
	DefaultPingPeriod = 10
)

定义相关默认值

Types

type CommandConfig

type CommandConfig struct {
	PushMessageWithError bool // 当调度指令时,指令执行错误,是否想客户端推送错误消息
	LogUpData            bool // 记录上行数据(客户端发送上来的数据)
	LogDownData          bool // 记录响应数据(服务端向客户端响应的数据)
	ResponseData         bool // 是否需要向客户端响应数据
}

CommandConfig 指令相关配置

Author : go_developer@163.com<白茶清欢>

Date : 2:36 下午 2021/4/17

func NewCommandConfig

func NewCommandConfig(optionFunc ...SetCommandConfig) *CommandConfig

NewCommandConfig 指令的配置

Author : go_developer@163.com<白茶清欢>

Date : 2:39 下午 2021/4/17

type SetCommandConfig

type SetCommandConfig func(cc *CommandConfig)

SetCommandConfig 设置command配置

func CloseLogDownData

func CloseLogDownData() SetCommandConfig

CloseLogDownData 关闭记录下行数据

Author : go_developer@163.com<白茶清欢>

Date : 7:45 下午 2021/4/18

func CloseLogUpData

func CloseLogUpData() SetCommandConfig

CloseLogUpData 关闭记录上行数据

Author : go_developer@163.com<白茶清欢>

Date : 7:44 下午 2021/4/18

func ClosePushCommandErrorMessage

func ClosePushCommandErrorMessage() SetCommandConfig

ClosePushCommandErrorMessage 关闭指令执行异常时的消息推送

Author : go_developer@163.com<白茶清欢>

Date : 2:51 下午 2021/4/17

func CloseResponseData

func CloseResponseData() SetCommandConfig

CloseResponseData 关闭向客户端发送响应结果

Author : go_developer@163.com<白茶清欢>

Date : 7:47 下午 2021/4/18

type SetWSServerConfig

type SetWSServerConfig func(wsc *WSServerConfig)

SetWSServerConfig 设置WS-Server的配置

Author : go_developer@163.com<白茶清欢>

Date : 7:03 下午 2021/4/17

func DisableStoreConnection

func DisableStoreConnection() SetWSServerConfig

DisableStoreConnection 禁用连接存储

Author : go_developer@163.com<白茶清欢>

Date : 11:10 下午 2021/4/17

func EnableConsoleLog

func EnableConsoleLog() SetWSServerConfig

EnableConsoleLog 开启控制台日志输出

Author : zhangdeman001@ke.com<白茶清欢>

Date : 11:25 下午 2021/4/22

func EnablePprof

func EnablePprof(pprofPort int) SetWSServerConfig

EnablePprof 开启PProf,由于多模块共享一个进程,任意一个模块开启,就认为是开启

Author : go_developer@163.com<白茶清欢>

Date : 11:24 下午 2021/4/18

func SetConnectionManager

func SetConnectionManager(manager storage.IConnection) SetWSServerConfig

SetConnectionManager 连接管理实例

Author : go_developer@163.com<白茶清欢>

Date : 10:48 下午 2021/4/22

func SetMaxMessageBufferSize

func SetMaxMessageBufferSize(maxMessageBufferSize int) SetWSServerConfig

SetMaxMessageBufferSize 设置消息缓冲区

Author : go_developer@163.com<白茶清欢>

Date : 9:39 下午 2021/4/22

func SetMaxMessageSize

func SetMaxMessageSize(maxMessageSize int64) SetWSServerConfig

SetMaxMessageSize 限制消息大小

Author : go_developer@163.com<白茶清欢>

Date : 9:29 下午 2021/4/22

func SetPingPeriod

func SetPingPeriod(pingPeriod int) SetWSServerConfig

SetPingPeriod 设置探活时间间隔

Author : go_developer@163.com<白茶清欢>

Date : 10:00 下午 2021/4/22

func SetPongWait

func SetPongWait(pongWait int) SetWSServerConfig

SetPongWait 设置探活时,等待响应时间,单位 : 秒

Author : go_developer@163.com<白茶清欢>

Date : 9:55 下午 2021/4/22

func SetWSServerLogEnable

func SetWSServerLogEnable(logPath string, logFile string, logLevel zapcore.Level, splitInterval consts.LogSplit) SetWSServerConfig

SetWSServerLogEnable 开启日志记录

Author : go_developer@163.com<白茶清欢>

Date : 7:25 下午 2021/4/17

func SetWriteWait

func SetWriteWait(writeWaitTime int) SetWSServerConfig

SetWriteWait 设置消息写入的等待时间, 单位 : 秒

Author : go_developer@163.com<白茶清欢>

Date : 9:44 下午 2021/4/22

type WSServerConfig

type WSServerConfig struct {
	Mode              string              // 运行模式
	LogEnable         bool                // 开启日志
	LogConsole        bool                // 开启控制台日志输出
	LogPath           string              // 日志路径
	LogFile           string              // 日志文件名
	LogLevel          zapcore.Level       // 日志等级
	LogSplitInterval  consts.LogSplit     // 日至切割的时间间隔
	StoreConnection   bool                // 存储连接
	ConnectionManager storage.IConnection // 连接管理实例
	EnablePprof       bool                // 开启pprof, 默认关闭
	PprofPort         int                 // pprof监听的端口
	melody.Config                         // 长连接配置
}

WSServerConfig WS-Server的配置

Author : go_developer@163.com<白茶清欢>

Date : 7:02 下午 2021/4/17

func NewWSServerConfig

func NewWSServerConfig(optionList ...SetWSServerConfig) *WSServerConfig

NewWSServerConfig 生成新的WS-Server配置

Author : go_developer@163.com<白茶清欢>

Date : 7:21 下午 2021/4/17