Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · enum

Native::

ENetDecode

Experimental

Why bytes were refused as a net record, a payload or a batch.

Declaration

enum class ENetDecode : uint8_t
Header
#include "Native/Net/NetRecord.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainCore"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.

Description

A decoder never reads past its input.

Values

ValueMeaning
Ok = 0—
Truncated

The bytes end inside a field, or before the records a batch header announced.

BadVersion

Another kTerrainNetVersion, or a sculpt payload of another kSculptRecordVersion.

UnknownKind

A record kind this version does not know (FieldPatch included).

BadLength

A length that disagrees with the bytes, is zero where content is required, or exceeds kNetMaxPayloadBytes.

BadPayload

The payload does not decode as its kind, or a field is out of its range.

BadSequence

A sequence number of 0, one that overflows, a Repair in the log, or a batch that does not continue its stream.

BadContext

A batch's sculpt entry without a stroke context, a switch to an empty slot, or a continuing batch on a reader without a stream.

BadTag

A batch tag or flag bit this version does not define.

NonCanonical

Bytes the encoder never writes (an over-long varint, an unchanged field coded, a redundant context entry): re-encoding would differ.

TrailingBytes

Bytes after the last field or record.