vtx.foundation draft d03

VTX 1 · core · beta draft d03

VTX 1 Wire Specification: core

Oct 11, 2026, revised Nov 16, 202639 pagesALPN vtx1-d03MIT licence

§14Errors and close codes

There are three levels of error, and each is contained at the smallest level that works.

  • Scene errors affect one op. The client skips the op, reports it with a scene ERROR (Section 7) and keeps going.
  • Channel errors close one dynamic channel with CLOSE on that channel. An error on a well-known channel is a connection error.
  • Connection errors end the connection: the endpoint sends CLOSE on channel 0 with a code, then closes the transport. The client then resumes if the code allows it.
Code Name Meaning Client resumes?
0x00 no_error Normal close, including after DETACH Only if the user reconnects
0x01 protocol_error Malformed frame or a rule of this spec broken No
0x02 internal_error Implementation failure Yes
0x03 flow_control_error Sent beyond the window No
0x04 frame_too_large Payload above max_frame No
0x05 version_unsupported No common major version No
0x06 auth_failed Authentication failed and no retry is allowed No
0x07 taken_over The session resumed on another connection No
0x08 going_away Server shutting down or moving; see GOAWAY's reconnect Yes
0x09 idle_timeout Nothing received for idle seconds Yes
0x0A limit_exceeded A negotiated limit was exceeded No
0x0B refused Channel open refused (OPEN_REFUSED only) Not applicable
0x0C policy_violation Zone or permission misuse, such as an approval flood No
0x0D session_ended The application ended; CLOSE carries exit or signal when known No

Codes 0x0E–0x3F are reserved for this specification and its extensions. The extensions assign 0x0E user_stopped (Media 1), 0x0F revoked (Devices 1), and 0x10 not_admitted and 0x11 removed (Viewers 1). 0x40 and up are free for implementations.

Limits and their errors

Limit Exceeded by Result
max_frame, and 4,096 bytes for HELLO A frame payload Connection error frame_too_large
window Data sent beyond the credit Connection error flow_control_error
scene_nodes, glyph_slots An op that would exceed it Op skipped, scene ERROR limit
cache_bytes An offered resource Client answers DROP
retain Updates the client has not acknowledged Server resumes with a reset snapshot
max_update The parts of one update together Connection error limit_exceeded
max_clip A clipboard item Server: connection error limit_exceeded; client: the item is left out of DATA
8 pending zone and clipboard requests A ninth request Connection error policy_violation
Any other negotiated limit The peer Connection error limit_exceeded