framing

Documentation

Overview

Package framing implements Game Protocol 1's canonical unsigned-LEB128 stream frames. It does not decode or authorize Protobuf messages.

Index

• Constants
• Variables
• func Read(reader io.Reader, limit uint32) ([]byte, error)
• func Write(writer io.Writer, payload []byte, limit uint32) error

Constants

const (
	MaximumGameplayFrame = uint32(1 << 20)
	MaximumResourceFrame = uint32(4 << 20)
)

Variables

var (
	ErrEmptyFrame       = errors.New("game protocol frame is empty")
	ErrFrameTooLarge    = errors.New("game protocol frame exceeds the role limit")
	ErrLengthOverflow   = errors.New("game protocol frame length overflows uint32")
	ErrNonCanonicalSize = errors.New("game protocol frame length is not canonical")
)

Functions

func Read

func Read(reader io.Reader, limit uint32) ([]byte, error)

Read reads one complete frame. It validates the length before allocating and never returns a partial payload.

func Write

func Write(writer io.Writer, payload []byte, limit uint32) error

Write writes one complete canonical frame.