proto

Documentation

Index

• Variables
• func WireWrite(resp *bytes.Buffer, w WireEncoder, data interface{}) error
• type QueryBase
  • func (q *QueryBase) ChallengeMatchesForClient(clientAddress string, challenge uint32) error
  • func (q *QueryBase) GenerateChallenge(clientAddress string) (uint32, error)
• type QueryResponder
• type QueryState
• type WireEncoder

Variables

var (
	ErrChallengeMalformed = errors.New("challenge malformed")
	ErrChallengeMismatch  = errors.New("challenge mismatch")
	ErrNoChallenge        = errors.New("no challenge")
)

Functions

func WireWrite

func WireWrite(resp *bytes.Buffer, w WireEncoder, data interface{}) error

WireWrite writes the provided data to resp with the provided WireEncoder w.

Types

type QueryBase

type QueryBase struct {
	State *QueryState
	// contains filtered or unexported fields
}

QueryBase is the base querying struct which can be used by other implementers to handle features such as challenge generation.

func (*QueryBase) ChallengeMatchesForClient

func (q *QueryBase) ChallengeMatchesForClient(clientAddress string, challenge uint32) error

ChallengeMatchesForClient determines whether the challenge value supplied by the client matches what is stored by this server.

func (*QueryBase) GenerateChallenge

func (q *QueryBase) GenerateChallenge(clientAddress string) (uint32, error)

GenerateChallenge generates a challenge value for the calling client address. If stale challenges have not been purged for a while, this is done asynchronously.

type QueryResponder

type QueryResponder interface {
	Respond(clientAddress string, buf []byte) ([]byte, error)
}

QueryResponder represents an interface to a concrete type which responds to query requests.

type QueryState

type QueryState struct {
	CurrentPlayers int32
	MaxPlayers     int32
	ServerName     string
	GameType       string
	Map            string
	Port           uint16
	Metrics        []float32
}

QueryState represents the state of a currently running game.

type WireEncoder

type WireEncoder interface {
	WriteString(resp *bytes.Buffer, s string) error
	Write(resp *bytes.Buffer, v interface{}) error
}

WireEncoder is an interface which allows for different query implementations to write data to a byte buffer in a specific format.