config

README

config 配置

Documentation

Index

• Variables
• type Base
  • func (p *Base) Configure() error
  • func (p *Base) ProcessingModeIsActor() bool
• type Etcd
  • func (p *Etcd) Configure() error
• type Grpc
  • func (p *Grpc) Configure() error
  • func (p *Grpc) HasListenAddr() bool
  • func (p *Grpc) IsEnabled() bool
• type KCP
  • func (p *KCP) Configure() error
• type Log
  • func (p *Log) Configure() error
• type Mgr
  • func NewMgr() *Mgr
  • func (p *Mgr) GetCustomBool(key string, defaultValue ...bool) bool
  • func (p *Mgr) GetCustomDuration(key string, defaultValue ...time.Duration) time.Duration
  • func (p *Mgr) GetCustomInt(key string, defaultValue ...int) int
  • func (p *Mgr) GetCustomInt64(key string, defaultValue ...int64) int64
  • func (p *Mgr) GetCustomString(key string, defaultValue ...string) string
  • func (p *Mgr) GetCustomUint32(key string, defaultValue ...uint32) uint32
  • func (p *Mgr) GetCustomUint64(key string, defaultValue ...uint64) uint64
  • func (p *Mgr) Parse(executablePath string) error
• type Nats
  • func (p *Nats) Configure() error
• type Net
  • func (p *Net) Configure() error
• type Redis
  • func (p *Redis) Configure() error
• type Timer
  • func (p *Timer) Configure() error
  • func (p *Timer) GetMillisecondType() xtimerconstants.MillisecondType
  • func (p *Timer) GetScanMillisecondDuration() time.Duration
  • func (p *Timer) GetScanSecondDuration() time.Duration

Variables

var GConfigMgr = NewMgr()

Types

type Base

type Base struct {
	ProjectName                 *string                          `yaml:"projectName"`                 // 项目名称		[default]:constants.ProjectNameDefault
	GroupID                     *uint32                          `yaml:"groupID"`                     // 分组ID
	Name                        *string                          `yaml:"name"`                        // 服务名称
	ServerID                    *uint32                          `yaml:"serverID"`                    // 服务ID
	Version                     *string                          `yaml:"version"`                     // 版本号		[default]: constants.VersionDefault
	PprofHttpPort               *uint16                          `yaml:"pprofHttpPort"`               // pprof性能分析 http端口		[default]: nil 不使用
	GoMaxProcess                *int                             `yaml:"goMaxProcess"`                // [default]: runtime.NumCPU()
	PacketLengthMax             *uint32                          `yaml:"packetLengthMax"`             // bytes,用户 上行 每个包的最大长度		[default]: math.MaxUint32
	SendChannelCapacity         *uint32                          `yaml:"sendChannelCapacity"`         // bytes,每个链接的发送chan容量		[default]: 1024
	RunMode                     *uint32                          `yaml:"runMode"`                     // 运行模式 [0:release 1:debug]		[default]: 1
	AvailableLoad               *uint32                          `yaml:"availableLoad"`               // 可用资源数		[default]: 1000000
	PacketLimitRecvCntPreSecond *uint32                          `yaml:"packetLimitRecvCntPreSecond"` // 每秒接收包数限制		[default]: math.MaxUint32
	ProcessingMode              *xconfigconstants.ProcessingMode `yaml:"processingMode"`              // 处理-模式 [0:bus 1:actor]		[default]: ProcessingModeActor
}

func (*Base) Configure

func (p *Base) Configure() error

func (*Base) ProcessingModeIsActor

func (p *Base) ProcessingModeIsActor() bool

type Etcd

type Etcd struct {
	Endpoints []string `yaml:"endpoints"` // etcd地址
	// YAML 须为 Go duration 字面量,如 100ms, 1s
	TTLDuration *time.Duration `yaml:"ttlDuration"` // ttlDuration [default]: xetcdconstants.TtlSecondDefault, e.g.:系统每10秒续约一次,该参数至少为11秒
}

func (*Etcd) Configure

func (p *Etcd) Configure() error

type Grpc

type Grpc struct {
	PackageName  *string `yaml:"packageName"`  // 包名
	ServiceName  *string `yaml:"serviceName"`  // 服务名称
	ListenAddr   *string `yaml:"listenAddr"`   // 服务地址-Listen (如果配置,则Listen服务) e.g.: 127.0.0.1:8989		[default]: "127.0.0.1:6523"
	ExternalAddr *string `yaml:"externalAddr"` // 服务地址-对外 e.g.: 127.0.0.1:8989		[default]: 未配置-使用 -> 服务地址-Listen
}

Grpc gRPC 服务配置 通过

func (*Grpc) Configure

func (p *Grpc) Configure() error

func (*Grpc) HasListenAddr

func (p *Grpc) HasListenAddr() bool

func (*Grpc) IsEnabled

func (p *Grpc) IsEnabled() bool

是否启用

type KCP

type KCP struct {
	Password *string `yaml:"password"` // 密码		[default]: "demo.pass"
	Salt     *string `yaml:"salt"`     // 盐		[default]: "demo.salt"
}

func (*KCP) Configure

func (p *KCP) Configure() error

type Log

type Log struct {
	Level   *uint32 `yaml:"level"`   // 日志等级
	AbsPath *string `yaml:"absPath"` // 日志绝对路径		[default]: 当前执行的程序-绝对路径,指向启动当前进程的可执行文件-目录路径. e.g.:absPath/log
}

func (*Log) Configure

func (p *Log) Configure() error

type Mgr

type Mgr struct {
	ExecutablePath string         // 绝对路径
	Content        string         // 内容
	Etcd           Etcd           `yaml:"etcd"`
	Base           Base           `yaml:"base"`
	Log            Log            `yaml:"log"`
	Timer          Timer          `yaml:"timer"`
	Net            []*Net         `yaml:"net"`
	KCP            KCP            `yaml:"kcp"`
	Grpc           Grpc           `yaml:"grpc"`
	Redis          []*Redis       `yaml:"redis"`
	Nats           []*Nats        `yaml:"nats"`
	Custom         map[string]any `yaml:"custom"` // 自定义配置，支持各模块自行解析

}

func NewMgr

func NewMgr() *Mgr

func (*Mgr) GetCustomBool

func (p *Mgr) GetCustomBool(key string, defaultValue ...bool) bool

GetCustomBool 获取 bool 类型的配置值（额外提供）

func (*Mgr) GetCustomDuration

func (p *Mgr) GetCustomDuration(key string, defaultValue ...time.Duration) time.Duration

GetCustomDuration 获取 time.Duration 类型的配置值，支持 "3s"、"1m" 等 Go duration 字符串。

func (*Mgr) GetCustomInt

func (p *Mgr) GetCustomInt(key string, defaultValue ...int) int

GetCustomInt 获取 int 类型的配置值（额外提供）

func (*Mgr) GetCustomInt64

func (p *Mgr) GetCustomInt64(key string, defaultValue ...int64) int64

func (*Mgr) GetCustomString

func (p *Mgr) GetCustomString(key string, defaultValue ...string) string

GetCustomString 获取 string 类型的配置值

func (*Mgr) GetCustomUint32

func (p *Mgr) GetCustomUint32(key string, defaultValue ...uint32) uint32

GetCustomUint32 获取 uint32 类型的配置值

func (*Mgr) GetCustomUint64

func (p *Mgr) GetCustomUint64(key string, defaultValue ...uint64) uint64

func (*Mgr) Parse

func (p *Mgr) Parse(executablePath string) error

type Nats

type Nats struct {
	Name     *string  `yaml:"name"`     // 名称		[default]: "natsName"
	Addrs    []string `yaml:"addrs"`    // 地址
	User     *string  `yaml:"user"`     // 用户
	Password *string  `yaml:"password"` // 密码		[default]:"123456"
}

func (*Nats) Configure

func (p *Nats) Configure() error

type Net

type Net struct {
	Name         *string `yaml:"name"`         // 链接名称		[default]: "netName"
	Type         *string `yaml:"type"`         // [tcp, kcp, websocket]		[default]: common.ServerNetTypeNameTCP
	ListenAddr   *string `yaml:"listenAddr"`   // 服务地址-Listen (如果配置,则Listen服务) e.g.: 127.0.0.1:8989
	ExternalAddr *string `yaml:"externalAddr"` // 服务地址-对外 e.g.: 127.0.0.1:8989		[default]: 未配置-使用 -> 服务地址-Listen
	Pattern      *string `yaml:"pattern"`      // 用于 type: websocket
}

func (*Net) Configure

func (p *Net) Configure() error

type Redis

type Redis struct {
	Name     *string  `yaml:"name"`     // 名称		[default]: "redisName"
	Addrs    []string `yaml:"addrs"`    // 地址
	Password *string  `yaml:"password"` // 密码		[default]:"123456"
	// YAML 须为 Go duration 字面量,如 100ms, 1s
	DialTimeoutDuration *time.Duration `yaml:"dialTimeoutDuration"` // 连接超时时间	[default]: 3s
	// YAML 须为 Go duration 字面量,如 100ms, 1s
	ReadTimeoutDuration *time.Duration `yaml:"readTimeoutDuration"` // 读超时时间	[default]: 3s
	// YAML 须为 Go duration 字面量,如 100ms, 1s
	WriteTimeoutDuration *time.Duration `yaml:"writeTimeoutDuration"` // 写超时时间	[default]: 3s
}

func (*Redis) Configure

func (p *Redis) Configure() error

type Timer

type Timer struct {
	// 秒级定时器扫描间隔 [default]: timer.ScanSecondDurationDefault
	// YAML 须为 Go duration 字面量,如 100ms, 1s
	ScanSecondDuration *time.Duration `yaml:"scanSecondDuration"`
	// 毫秒级定时器扫描间隔 [default]: timer.ScanMillisecondDurationDefault
	ScanMillisecondDuration *time.Duration `yaml:"scanMillisecondDuration"`
	// 毫秒级定时器实现类型 [default]: timer.MillisecondTypeList
	MillisecondType *xtimerconstants.MillisecondType `yaml:"millisecondType"`
}

func (*Timer) Configure

func (p *Timer) Configure() error

func (*Timer) GetMillisecondType

func (p *Timer) GetMillisecondType() xtimerconstants.MillisecondType

func (*Timer) GetScanMillisecondDuration

func (p *Timer) GetScanMillisecondDuration() time.Duration

func (*Timer) GetScanSecondDuration

func (p *Timer) GetScanSecondDuration() time.Duration