constants

Documentation

Index

• Constants
• Variables
• func GetCfgPath() string
• func GetServerDBPath() string
• type LogType

Constants

const (
	// ConfigDirectory specifies the directory in which to store the config file.
	ConfigDirectory = "conf"
	// ConfigFilename specifies the name of the configuration file.
	ConfigFilename = "config.conf"
	// DebugConfigFilename specifies the name of the configuration file to use when
	// debug mode is set
	DebugConfigFilename = "debug.conf"
)

const (
	// DbDirectory specifies the directory in which to store the database files.
	DbDirectory = "db"
	// ServerDbFilename specifies the name of the server database file.
	ServerDbFilename = "servers.sqlite"
	// CountryMMDbFilename specifies the name of geolocation database file.
	CountryMMDbFilename = "GeoLite2-City.mmdb"
)

const (
	// LogDirectory specifies the directory in which to store the log files.
	LogDirectory = "logs"
	// AppLogFilename specifies the name of the application log file.
	AppLogFilename = "app.log"
	// SteamLogFilename specifies the name of the Steam log file.
	SteamLogFilename = "steam.log"
	// WebLogFilename specifies the name of the web log file.
	WebLogFilename = "web.log"
)

const (
	// DumpDirectory represents the directory name used for server dump JSON files.
	DumpDirectory = "dump"
	// GameFile specifies the name of the Steam games file.
	GameFile = "games.conf"
)

const (
	// TestTempDirectory specifies the temporary directory for test-related files.
	TestTempDirectory = "test_temp"
	// TestConfigFilename specifies the name of the test configuration file.
	TestConfigFilename = "test.conf"
	// TestServerDbFilename specifies the name of the server database file used in
	// tests.
	TestServerDbFilename = "servers_test.sqlite"
)

Variables

var (
	// IsDebug will determine whether the debug configuration is used. This is
	// set on application startup.
	IsDebug = false
	// IsTest will determine whether the test configuration is used when running
	// tests. This variable is only set when running tests.
	IsTest = false
	// ConfigFilePath represents the OS-independent full path to the config file.
	ConfigFilePath = path.Join(ConfigDirectory, ConfigFilename)
	// DebugConfigFilePath represents the OS-independent full path to the debug
	// configuration file.
	DebugConfigFilePath = path.Join(ConfigDirectory, DebugConfigFilename)
)

var (
	// CountryDbFilePath represents the OS-independent full path to the geolocation DB file.
	CountryDbFilePath = path.Join(DbDirectory, CountryMMDbFilename)
	// ServerDbFilePath represents the OS-independent full path to the server DB file.
	ServerDbFilePath = path.Join(DbDirectory, ServerDbFilename)
)

var (
	// AppLogFilePath represents the OS-independent full path to app log file.
	AppLogFilePath = path.Join(LogDirectory, AppLogFilename)
	// SteamLogFilePath represents the OS-independent full path to Steam log file.
	SteamLogFilePath = path.Join(LogDirectory, SteamLogFilename)
	// WebLogFilePath represents the OS-independent full path to web log file.
	WebLogFilePath = path.Join(LogDirectory, WebLogFilename)
)

var (
	// DumpFileFullPath represents the OS-independent full path to the server dump
	// JSON file.
	DumpFileFullPath = func(dumpfile string) string {
		return path.Join(DumpDirectory, dumpfile)
	}
	// GameFileFullPath represents the OS-independent full path to the game file.
	GameFileFullPath = path.Join(ConfigDirectory, GameFile)
	// Version is the version number of the application.
	Version = "0.1.8"
	// AppInfo contains the application information.
	AppInfo = fmt.Sprintf("a2sapi v%s by syncore <syncore@syncore.org>", Version)
)

var (
	// TestConfigFilePath represents the OS-independent full path to the config file.
	TestConfigFilePath = path.Join(TestTempDirectory, TestConfigFilename)
	// TestServerDbFilePath represents the OS-independent full path to the server
	// database file used in tests.
	TestServerDbFilePath = path.Join(TestTempDirectory, TestServerDbFilename)

	// TestServerDumpJSON is the JSON used for the server dump when performing
	// tests.
	TestServerDumpJSON = []byte(`
{"retrievalDate":"Sat Dec 26 23:08:14 2015 EST","timestamp":1451189294,
"serverCount":3,"servers":[{"serverId":1029,"address":"54.172.5.67:25801",
"ip":"54.172.5.67","port":25801,"location":{"countryName":"United States",
"countryCode":"US","region":"North America","state":"VA"},
"info":{"protocol":17,"serverName":"TurboPixel Appreciation Society (Official) #1",
"map":"xfdm2","gameDir":"base","game":"Reflex","players":5,"maxPlayers":8,
"serverType":"dedicated","serverOS":"Windows","antiCheat":1,"serverVersion":"0.38.2",
"extra":{"gamePort":25800,"serverSteamId":90098615517053960,"sourceTvProxyPort":0,
"sourceTvProxyName":"","keywords":"atdm||62|1","steamAppId":328070}},
"players":[{"name":"KovaaK","score":92,"secsConnected":4317.216,
"totalConnected":"1h11m57s"},{"name":"Sharqosity","score":42,
"secsConnected":3428.6987,"totalConnected":"57m8s"},{"name":"dhaK","score":42,
"secsConnected":1730.0668,
"totalConnected":"28m50s"},{"name":"yoo","score":45,"secsConnected":467.6571,
"totalConnected":"7m47s"},{"name":"twitch.tv/liveanton - SANE","score":75,
"secsConnected":452.20792,"totalConnected":"7m32s"}],
"realPlayers":{"count":5,"players":[{"name":"KovaaK","score":92,
"secsConnected":4317.216,"totalConnected":"1h11m57s"},{"name":"Sharqosity",
"score":42,"secsConnected":3428.6987,"totalConnected":"57m8s"},{"name":"dhaK",
"score":42,"secsConnected":1730.0668,"totalConnected":"28m50s"},{"name":"yoo",
"score":45,"secsConnected":467.6571,"totalConnected":"7m47s"},
{"name":"twitch.tv/liveanton - SANE","score":75,"secsConnected":452.20792,
"totalConnected":"7m32s"}]},"rules":{}},{"serverId":360,"address":"192.211.62.11:27960",
"ip":"192.211.62.11","port":27960,"location":{"countryName":"United States",
"countryCode":"US","region":"North America","state":"TX"},"info":{"protocol":17,
"serverName":"exile.syncore.org | US-Central #1 | Competitive","map":"overkill",
"gameDir":"baseq3","game":"Clan Arena","maxPlayers":16,"serverType":"dedicated",
"serverOS":"Linux","antiCheat":1,"serverVersion":"1066","extra":{"gamePort":27960,
"serverSteamId":90098677041473542,"sourceTvProxyPort":0,"sourceTvProxyName":"",
"keywords":"clanarena,minqlx,syncore,texas,central,newmaps","steamAppId":282440}},
"players":[],"realPlayers":{"count":0,"players":[]},"rules":{"capturelimit":"8",
"dmflags":"28","fraglimit":"50","g_adCaptureScoreBonus":"3","g_adElimScoreBonus":"2",
"g_adTouchScoreBonus":"1","g_blueScore":"","g_customSettings":"0","g_factory":"ca",
"g_factoryTitle":"Clan Arena","g_freezeRoundDelay":"4000","g_gameState":"PRE_GAME",
"g_gametype":"4","g_gravity":"800",
"g_instaGib":"0","g_itemHeight":"35","g_itemTimers":"1","g_levelStartTime":"1451179049",
"g_loadout":"0","g_needpass":"0","g_overtime":"0","g_quadDamageFactor":"3","g_redScore":"",
"g_roundWarmupDelay":"10000","g_startingHealth":"200","g_teamForceBalance":"1",
"g_teamSizeMin":"1","g_timeoutCount":"0","g_voteFlags":"0","g_weaponRespawn":"5",
"mapname":"overkill","mercylimit":"0","protocol":"91","roundlimit":"10",
"roundtimelimit":"180","scorelimit":"150",
"sv_hostname":"exile.syncore.org | US-Central #1 | Competitive",
"sv_maxclients":"16","sv_privateClients":"0","teamsize":"4","timelimit":"0",
"version":"1066 linux-x64 Dec 17 2015 15:36:49"}},{"serverId":746,
"address":"45.55.168.160:27960","ip":"45.55.168.160","port":27960,
"location":{"countryName":"United States","countryCode":"US","region":"North America",
"state":"NY"},"info":{"protocol":17,
"serverName":"triton.syncore.org | US-East #1 | Competitive","map":"overkill",
"gameDir":"baseq3","game":"Clan Arena","maxPlayers":16,"serverType":"dedicated",
"serverOS":"Linux","antiCheat":1,"serverVersion":"1066","extra":{"gamePort":27960,
"serverSteamId":90098677079644165,
"sourceTvProxyPort":0,"sourceTvProxyName":"",
"keywords":"clanarena,minqlx,syncore,newyork,east,newmaps","steamAppId":282440}},
"players":[],"realPlayers":{"count":0,"players":[]},"rules":{"capturelimit":"8",
"dmflags":"28","fraglimit":"50","g_adCaptureScoreBonus":"3","g_adElimScoreBonus":"2",
"g_adTouchScoreBonus":"1","g_blueScore":"","g_customSettings":"0","g_factory":"ca",
"g_factoryTitle":"Clan Arena","g_freezeRoundDelay":"4000","g_gameState":"PRE_GAME",
"g_gametype":"4",
"g_gravity":"800","g_instaGib":"0","g_itemHeight":"35","g_itemTimers":"1",
"g_levelStartTime":"1451179064","g_loadout":"0","g_needpass":"0","g_overtime":"0",
"g_quadDamageFactor":"3","g_redScore":"","g_roundWarmupDelay":"10000",
"g_startingHealth":"200","g_teamForceBalance":"1","g_teamSizeMin":"1",
"g_timeoutCount":"0","g_voteFlags":"0","g_weaponRespawn":"5","mapname":"overkill",
"mercylimit":"0","protocol":"91","roundlimit":"10","roundtimelimit":"180",
"scorelimit":"150","sv_hostname":"triton.syncore.org | US-East #1 | Competitive",
"sv_maxclients":"16","sv_privateClients":"0","teamsize":"4","timelimit":"0",
"version":"1066 linux-x64 Dec 17 2015 15:36:49"}}],"failedCount":0,"failedServers":[]}
`)
)

Functions

func GetCfgPath

func GetCfgPath() string

GetCfgPath returns the full OS-independent path to the configuration file.

func GetServerDBPath

func GetServerDBPath() string

GetServerDBPath returns the full OS-independent path to the server DB file.

Types

type LogType

type LogType int

LogType represents the type of log.

const (
	// LTypeApp represents the Application-related log type.
	LTypeApp LogType = iota
	// LTypeDebug represents the Debug-related log type.
	LTypeDebug
	// LTypeSteam represents the Steam-related log type.
	LTypeSteam
	// LTypeWeb represents the Web-related log type.
	LTypeWeb
)