protocol

Documentation

Index

• Constants
• Variables
• func Clen(n []byte) int
• func NewServersMapFromList(input []string) map[string]*Server
• func ReadCString(input []byte) string
• func ReadPascalString(input []byte) string
• func ReadPascalStringStream(input []byte) (string, []byte)
• func WriteCString(input string) []byte
• func WritePascalString(input string) ([]byte, error)
• type Options
• type Packet
  • func NewPacket() *Packet
  • func NewPacketWithData(data []byte) (*Packet, error)
  • func (p *Packet) MarshalBinary() ([]byte, error)
  • func (p *Packet) String() string
  • func (p *Packet) UnmarshalBinary(data []byte) error
• type PacketType
  • func (p PacketType) String() string
• type Server
  • func NewServerFromString(input string, ttl int) (*Server, error)
  • func (s Server) IsExpired() bool
  • func (s Server) String() string

Constants

const HeaderSize = 8

const MaxDataSize = MaxPacketSize - HeaderSize

const MaxPacketSize = 1500 // standard packet MTU

const RequestAllPackets = 0xff

const Version = 0x10

const VersionExt = 0x69

Variables

var ErrorEmptyPacket = errors.New("empty packet received")

var (
	ErrorPascalStringTooLong = errors.New("pascal string too long")
)

var ErrorUnknownPacketVersion = errors.New("unknown packet version")

Functions

func Clen

func Clen(n []byte) int

Clen returns the position of the first null byte in a given byte slice for null-terminated c strings, this returns the length of the string function was yanked from a golang stdlib private method.

func NewServersMapFromList

func NewServersMapFromList(input []string) map[string]*Server

func ReadCString

func ReadCString(input []byte) string

func ReadPascalString

func ReadPascalString(input []byte) string

func ReadPascalStringStream

func ReadPascalStringStream(input []byte) (string, []byte)

func WriteCString

func WriteCString(input string) []byte

func WritePascalString

func WritePascalString(input string) ([]byte, error)

Types

type Options

type Options struct {
	Search  map[string]*Server
	Timeout time.Duration
	Debug   bool

	MaxServerPacketSize uint16
	PacketKey           uint16
}

type Packet

type Packet struct {
	Version byte
	Type    PacketType
	Number  byte   // packet number out of total; starts at 1
	Total   byte   // total packets of info
	Key     uint16 // used for verification and (transaction) id purposes
	ID      uint16 // master server id (read from config file)
	Data    []byte // MaxSize = (MaxPacketSize - HeaderSize)

	// implements
	encoding.BinaryMarshaler
	encoding.BinaryUnmarshaler
	fmt.Stringer
}

func NewPacket

func NewPacket() *Packet

func NewPacketWithData

func NewPacketWithData(data []byte) (*Packet, error)

func (*Packet) MarshalBinary

func (p *Packet) MarshalBinary() ([]byte, error)

func (*Packet) String

func (p *Packet) String() string

func (*Packet) UnmarshalBinary

func (p *Packet) UnmarshalBinary(data []byte) error

type PacketType

type PacketType int

const (
	PingInfoQuery PacketType = iota + 0x03
	PingInfoResponse
	MasterServerHeartbeat
	MasterServerList
	GameInfoQuery
	GameInfoResponse
)

func (PacketType) String

func (p PacketType) String() string

type Server

type Server struct {
	Address    *net.UDPAddr
	Connection *net.PacketConn
	LastSeen   time.Time
	TTL        int
	Info       *Packet
}

func NewServerFromString

func NewServerFromString(input string, ttl int) (*Server, error)

func (Server) IsExpired

func (s Server) IsExpired() bool

func (Server) String

func (s Server) String() string