common

Documentation

Index

• Constants
• type CheckinResponse
• type GameDataContainer
  • func (container *GameDataContainer) Encode() []byte
• type InfoResponse
• type RestLobby

Constants

const APIVersion uint = 2

APIVersion is the version of the REST API implemented in this file

const SoftwareName = "vic2-multi-proxy"

SoftwareName is the name of this software

const SoftwareVersion = "v1.0.1-alpha"

SoftwareVersion is the version of this software

Types

type CheckinResponse

type CheckinResponse struct {
	Lobbies     map[string]RestLobby `json:"lobbies"`
	Hosting     bool                 `json:"hosting"`
	LinkedLobby uint64               `json:"linkedTo"`
}

CheckinResponse is the JSON response to the /checkin REST method

type GameDataContainer

type GameDataContainer struct {
	Relay  bool
	Origin uint16
	Data   []byte
}

func (*GameDataContainer) Encode

func (container *GameDataContainer) Encode() []byte

type InfoResponse

type InfoResponse struct {
	Software string `json:"software"`
	Version  string `json:"version"`
	API      uint   `json:"apiVersion"`
}

InfoResponse is the JSON response to the /info REST method

type RestLobby

type RestLobby struct {
	Name string `json:"name"`
	Host string `json:"host"`
}

RestLobby represents a Lobby in the lobbies dictionary in the CheckinResponse struct