cosgo

README

cosgo

go game 开发中

Documentation

Index

• Constants
• Variables
• func Abs(dir ...string) string
• func Close(force bool)
• func Console(format any, args ...any)
• func Debug() bool
• func Dir() string
• func Modules() (r []string)
• func Name() string
• func On(e EventType, f EventFunc)
• func Reload()
• func SIGHUP()
• func SetBanner(f func())
• func SetProcess(f func() bool)
• func Start(waitForSystemExit bool, mods ...IModule)
• func Use(mods ...IModule)
• func WaitForSystemExit()
• func WorkDir() string
• type EventFunc
• type EventType
• type IModule
• type Module
  • func NewModule(id string) *Module
  • func (m *Module) Close() error
  • func (m *Module) ID() string
  • func (m *Module) Init() error
  • func (m *Module) Reload() error
  • func (m *Module) Start() error

Constants

const (
	AppConfigDebug              string = "debug"
	AppConfigNamePidFile        string = "pid"           //pid file dir
	AppConfigNameLogsDir        string = "logs"          //logs dir
	AppConfigNameDaemonize      string = "daemonize"     //后台运行
	AppConfigNameConfigFileExt  string = "ConfigFileExt" //config file default ext name,只能在程序中设置
	AppConfigNameConfigFileName string = "config"        //config file

)

Variables

var Config = &config{Viper: viper.New()}

var GCSummaryTime time.Duration = time.Second * 300

GCSummaryTime 报告性能摘要时间间隔

var Options = &struct {
	Banner  func()
	Process func() bool //设置启动进程，返回false时不会继续向下执行

}{
	Banner: defaultBanner,
}

var SignalReload syscall.Signal = 10

SignalReload 重新加载系统信号 kill -10 pid

var Version string = "unknown"

Functions

func Abs

func Abs(dir ...string) string

Abs 获取以工作路径为起点的绝对路径

func Close

func Close(force bool)

Close 外部关闭程序

func Console

func Console(format any, args ...any)

Console 控制台输出

func Debug

func Debug() bool

func Dir

func Dir() string

Dir APP主程序所在目录

func Modules

func Modules() (r []string)

func Name

func Name() string

Name 项目内部获取appName

func On

func On(e EventType, f EventFunc)

func Reload

func Reload()

func SIGHUP

func SIGHUP()

SIGHUP 关闭控制台

func SetBanner

func SetBanner(f func())

SetBanner 设置默认启动界面，启动完所有MOD后执行

func SetProcess

func SetProcess(f func() bool)

func Start

func Start(waitForSystemExit bool, mods ...IModule)

*

• 应用程序启动
• @param mods 需注册的模块

func Use

func Use(mods ...IModule)

func WaitForSystemExit

func WaitForSystemExit()

func WorkDir

func WorkDir() string

WorkDir 程序工作目录

Types

type EventFunc

type EventFunc func() error

type EventType

type EventType int32

const (
	EventTypStarting EventType = iota
	EventTypStarted
	EventTypStopping
	EventTypStopped
)

type IModule

type IModule interface {
	ID() string
	Init() error
	Start() error
	Close() error
	Reload() error
}

type Module

type Module struct {
	Id string
}

func NewModule

func NewModule(id string) *Module

func (*Module) Close

func (m *Module) Close() error

func (*Module) ID

func (m *Module) ID() string

func (*Module) Init

func (m *Module) Init() error

func (*Module) Reload

func (m *Module) Reload() error

func (*Module) Start

func (m *Module) Start() error