utils

Documentation

Overview

Package utils 提供zinx相关工具类函数 包括:

全局配置
配置文件加载

当前文件描述: @Title globalobj.go @Description 相关配置文件定义及加载方式 @Author Aceld - Thu Mar 11 10:32:29 CST 2019

Index

• func PathExists(path string) (bool, error)
• func UserConfToGlobal(config *Config)
• type Config
• type GlobalObj
  • func (g *GlobalObj) HeartbeatMaxDuration() time.Duration
  • func (g *GlobalObj) Reload()
  • func (g *GlobalObj) Show()

Functions

func PathExists

func PathExists(path string) (bool, error)

PathExists 判断一个文件是否存在

func UserConfToGlobal

func UserConfToGlobal(config *Config)

注意如果使用UserConf应该调用方法同步至 GlobalConfObject 因为其他参数是调用的此结构体参数

Types

type Config

type Config struct {

	//Server
	TcpServer  ziface.IServer //当前全局的Server对象
	Host       string         //当前服务器主机监听的IP
	TcpPort    int            //当前服务器监听的端口
	Name       string         //当前服务器的名称
	TcpVersion string         //tcp版本

	//服务器可选配置
	Version          string //版本
	MaxConn          int    //最大连接数量
	MaxPacketSize    uint32 //当前框架数据包的最大尺寸
	WorkerPoolSize   uint32 //业务工作Worker池的数量
	MaxWorkerTaskLen uint32 //业务工作Worker对应负责的任务队列最大任务存储数量
	MaxMsgChanLen    uint32 //SendBuffMsg发送消息的缓冲最大长度

	/*
		logger
	*/
	LogDir        string //日志所在文件夹 默认"./log"
	LogFile       string //日志文件名称   默认""  --如果没有设置日志文件，打印信息将打印至stderr
	LogDebugClose bool   //是否关闭Debug日志级别调试信息 默认false  -- 默认打开debug信息
}

type GlobalObj

type GlobalObj struct {
	/*
		Server
	*/
	TCPServer ziface.IServer //当前Zinx的全局Server对象
	Host      string         //当前服务器主机IP
	TCPPort   int            //当前服务器主机监听端口号
	Name      string         //当前服务器名称

	/*
		Zinx
	*/
	Version          string //当前Zinx版本号
	MaxPacketSize    uint32 //都需数据包的最大值
	MaxConn          int    //当前服务器主机允许的最大链接个数
	WorkerPoolSize   uint32 //业务工作Worker池的数量
	MaxWorkerTaskLen uint32 //业务工作Worker对应负责的任务队列最大任务存储数量
	MaxMsgChanLen    uint32 //SendBuffMsg发送消息的缓冲最大长度

	/*
		config file path
	*/
	ConfFilePath string

	/*
		logger
	*/
	LogDir        string //日志所在文件夹 默认"./log"
	LogFile       string //日志文件名称   默认""  --如果没有设置日志文件，打印信息将打印至stderr
	LogDebugClose bool   //是否关闭Debug日志级别调试信息 默认false  -- 默认打开debug信息

	/*
		Keepalive
	*/
	HeartbeatMax int //最长心跳检测间隔时间(单位：秒),超过改时间间隔，则认为超时，从配置文件读取
}

存储一切有关Zinx框架的全局参数，供其他模块使用 一些参数也可以通过 用户根据 zinx.json来配置

var GlobalObject *GlobalObj

定义一个全局的对象

func (*GlobalObj) HeartbeatMaxDuration

func (g *GlobalObj) HeartbeatMaxDuration() time.Duration

func (*GlobalObj) Reload

func (g *GlobalObj) Reload()

Reload 读取用户的配置文件

func (*GlobalObj) Show

func (g *GlobalObj) Show()

提示详细