common

README

Common

This module contains the code used by all internal modules.

No guarantees are given for the stability of the API.

Documentation

Index

• Constants
• Variables
• func CalculateBroadcastIp(ip net.IP, mask net.IPMask) net.IP
• func CertificatePair(executablePath string) (ok bool, parentDir string, cert string)
• func CertificatePairFolder(executablePath string) string
• func ChdirToExe()
• func GetExeFileName(bin bool, executable string) string
• func HostToIps(host string) []net.IP
• type AnnounceMessage
• type AnnounceMessageData000
• type AnnounceMessageData001

Constants

const (
	AnnounceVersion0 = iota
	AnnounceVersion1
)

const (
	ErrSuccess = iota
	ErrGeneral
	ErrSignal
	ErrPidLock
	// ErrLast is only used as a marker to where to start, not a real error
	ErrLast
)

const (
	GameAoE1 = "age1"
	GameAoE2 = "age2"
	GameAoE3 = "age3"
	// GameAoE4 Unsupported
	GameAoE4 = "age4"
	// GameAoM Unsupported
	GameAoM = "athens"
)

const AnnounceHeader = Name

const AnnounceIdLength = 16

const AnnouncePort = 31978

const AnnounceVersionLatest = AnnounceVersion1

const AnnounceVersionLength = 1

const Cert = "cert.pem"

const CertSubjectOrganization = "github.com/luskaner/" + Name

const Domain = "aoe-api.worldsedgelink.com"

const Key = "key.pem"

const LauncherAgent = "agent"

const LauncherConfig = "config"

const LauncherConfigAdmin = "config-admin"

const LauncherConfigAdminAgent = "config-admin-agent"

const Name = "ageLANServer"

const Server = "server"

const ServerGenCert = "genCert"

Variables

var AllGames = SupportedGames.Union(mapset.NewThreadUnsafeSet[string](GameAoE4, GameAoM))

var SupportedGames = mapset.NewThreadUnsafeSet[string](GameAoE1, GameAoE2, GameAoE3)

Functions

func CalculateBroadcastIp

func CalculateBroadcastIp(ip net.IP, mask net.IPMask) net.IP

func CertificatePair

func CertificatePair(executablePath string) (ok bool, parentDir string, cert string)

func CertificatePairFolder

func CertificatePairFolder(executablePath string) string

func ChdirToExe

func ChdirToExe()

func GetExeFileName

func GetExeFileName(bin bool, executable string) string

func HostToIps

func HostToIps(host string) []net.IP

Types

type AnnounceMessage

type AnnounceMessage struct {
	Data    interface{}
	Version byte
	Ips     mapset.Set[string]
}

type AnnounceMessageData000

type AnnounceMessageData000 struct {
}

AnnounceMessageData000 Empty interface to be used as a placeholder for the message type

type AnnounceMessageData001

type AnnounceMessageData001 struct {
	GameIds []string
}

AnnounceMessageData001 Data structure for the announce version 1