Skip to content
moqtap

MoQT draft-17 Error Codes

MoQT draft-17 assigns 59 code points across 4 registries — Session Termination, REQUEST_ERROR, PUBLISH_DONE and Data Stream Reset — plus 3 Object Status values, which are a separate family and are never counted with the rest. Of the 59, 55 are assignments and 4 are reserved.

Every row below was read out of draft-ietf-moq-transport-17 by the same extraction the moqtap Rust codec's conformance tests run against. Nothing here is transcribed by hand. The provenance section gives the hash of the document it came from.

What changed since draft-16

Section titled “What changed since draft-16”

Added

  • 0x7f * N + 0x9D RESERVED_FOR_GREASING (Session Termination)
  • 0x6 GOING_AWAY (REQUEST_ERROR)
  • 0x9 EXCESSIVE_LOAD (REQUEST_ERROR)
  • 0x31 NAMESPACE_TOO_LARGE (REQUEST_ERROR)
  • 0x7f * N + 0x9D RESERVED_FOR_GREASING (REQUEST_ERROR)
  • 0x9 EXCESSIVE_LOAD (PUBLISH_DONE)
  • 0x7f * N + 0x9D RESERVED_FOR_GREASING (PUBLISH_DONE)
  • 0x5 TOO_FAR_BEHIND (Data Stream Reset)
  • 0x9 EXCESSIVE_LOAD (Data Stream Reset)
  • 0x7f * N + 0x9D RESERVED_FOR_GREASING (Data Stream Reset)

Renamed

  • 0x7 INVALID_REQUIRED_REQUEST_ID — was TOO_MANY_REQUESTS in draft-16 (Session Termination)

Session Termination Error Codes

Section titled “Session Termination Error Codes”

draft-17 registers 22 code points in §14.5.1, and defines each one in §3.5.

Code Name Description Defined in
0x0 NO_ERROR The session is being terminated without an error. §3.5
0x1 INTERNAL_ERROR An implementation specific error occurred. §3.5
0x2 UNAUTHORIZED The client is not authorized to establish a session. §3.5
0x3 PROTOCOL_VIOLATION The remote endpoint performed an action that was disallowed by the specification. §3.5
0x4 INVALID_REQUEST_ID The endpoint received a Request ID with an incorrect least significant bit for the sender, or a duplicate Request ID. See Section 9.1. §3.5
0x5 DUPLICATE_TRACK_ALIAS The endpoint attempted to use a Track Alias that was already in use. §3.5
0x6 KEY_VALUE_FORMATTING_ERROR The key-value pair has a formatting error. §3.5
0x7 INVALID_REQUIRED_REQUEST_ID The endpoint received a Required Request ID Delta that results in an invalid Request ID. See Section 9.2. §3.5
0x8 INVALID_PATH The PATH parameter was used by a server, on a WebTransport session, or the server does not support the path. §3.5
0x9 MALFORMED_PATH The PATH parameter does not conform to the rules in Section 9.4.1.2. §3.5
0x10 GOAWAY_TIMEOUT The session was closed because the peer took too long to close the session in response to a GOAWAY (Section 9.5) message. See session migration (Section 3.6). §3.5
0x11 CONTROL_MESSAGE_TIMEOUT The session was closed because the peer took too long to respond to a control message. §3.5
0x12 DATA_STREAM_TIMEOUT The session was closed because the peer took too long to send data expected on an open Data Stream (see Section 10). This includes fields of a stream header or an object header within a data stream. If an endpoint times out waiting for a new object header on an open subgroup stream, it MAY send a STOP_SENDING on that stream or terminate the subscription. §3.5
0x13 AUTH_TOKEN_CACHE_OVERFLOW The Session limit Section 9.4.1.3 of the size of all registered Authorization tokens has been exceeded. §3.5
0x14 DUPLICATE_AUTH_TOKEN_ALIAS Authorization Token attempted to register an Alias that was in use (see Section 9.3.2). §3.5
0x15 VERSION_NEGOTIATION_FAILED The client didn't offer a version supported by the server. §3.5
0x16 MALFORMED_AUTH_TOKEN Invalid Auth Token serialization during registration (see Section 9.3.2). §3.5
0x17 UNKNOWN_AUTH_TOKEN_ALIAS No registered token found for the provided Alias (see Section 9.3.2). §3.5
0x18 EXPIRED_AUTH_TOKEN Authorization token has expired (Section 9.3.2). §3.5
0x19 INVALID_AUTHORITY The specified AUTHORITY does not correspond to this server or cannot be used in this context. §3.5
0x1A MALFORMED_AUTHORITY The AUTHORITY value is syntactically invalid. §3.5
0x7f * N + 0x9D Reserved for greasing Reserved — the draft assigns no meaning to this range. §14.5.1

22 code points from table-13 of draft-17 (§14.5.1. Session Termination Error Codes).

REQUEST_ERROR Codes

Section titled “REQUEST_ERROR Codes”

draft-17 registers 17 code points in §14.5.2, and defines each one in §9.7.

Code Name Description Defined in
0x0 INTERNAL_ERROR An implementation specific or generic error occurred. §9.7
0x1 UNAUTHORIZED The subscriber is not authorized to perform the requested action on the given track. This might be retryable if the authorization token is not yet valid. §9.7
0x2 TIMEOUT The subscription could not be completed before an implementation specific timeout. For example, a relay could not establish an upstream subscription within the timeout. §9.7
0x3 NOT_SUPPORTED The endpoint does not support the type of request. §9.7
0x4 MALFORMED_AUTH_TOKEN Invalid Auth Token serialization during registration (see Section 9.3.2). §9.7
0x5 EXPIRED_AUTH_TOKEN Authorization token has expired (Section 9.3.2). §9.7
0x6 GOING_AWAY The endpoint has received a GOAWAY and MAY reject new requests. §9.7
0x9 EXCESSIVE_LOAD The responder is overloaded and cannot process the request at this time. The sender SHOULD use the Retry Interval to indicate when the request can be retried. §9.7
0x10 DOES_NOT_EXIST The track or namespace is not available at the publisher. §9.7
0x11 INVALID_RANGE In response to SUBSCRIBE or FETCH, specified Filter or range of Locations cannot be satisfied. §9.7
0x12 MALFORMED_TRACK In response to a FETCH, a relay publisher detected the track was malformed (see Section 2.4.2). §9.7
0x19 DUPLICATE_SUBSCRIPTION The PUBLISH or SUBSCRIBE request attempted to create a subscription to a Track with the same role as an existing subscription. §9.7
0x20 UNINTERESTED The subscriber is not interested in the track or namespace. §9.7
0x30 PREFIX_OVERLAP In response to SUBSCRIBE_NAMESPACE, the namespace prefix overlaps with another SUBSCRIBE_NAMESPACE in the same session. §9.7
0x31 NAMESPACE_TOO_LARGE In response to SUBSCRIBE_NAMESPACE, the namespace prefix matches more publishers than the relay is willing to enumerate. §9.7
0x32 INVALID_JOINING_REQUEST_ID In response to a Joining FETCH, the referenced Request ID is not an Established Subscription. §9.7
0x7f * N + 0x9D Reserved for greasing Reserved — the draft assigns no meaning to this range. §14.5.2

17 code points from table-14 of draft-17 (§14.5.2. REQUEST_ERROR Codes).

PUBLISH_DONE Codes

Section titled “PUBLISH_DONE Codes”

draft-17 registers 11 code points in §14.5.3, and defines each one in §9.13.

Code Name Description Defined in
0x0 INTERNAL_ERROR An implementation specific or generic error occurred. §9.13
0x1 UNAUTHORIZED The subscriber is no longer authorized to subscribe to the given track. §9.13
0x2 TRACK_ENDED The track is no longer being published. §9.13
0x3 SUBSCRIPTION_ENDED The publisher reached the end of an associated subscription filter. §9.13
0x4 GOING_AWAY The subscriber or publisher issued a GOAWAY message. §9.13
0x5 EXPIRED The publisher reached the timeout specified in SUBSCRIBE_OK. §9.13
0x6 TOO_FAR_BEHIND The publisher's queue of objects to be sent to the given subscriber exceeds its implementation defined limit. §9.13
0x8 UPDATE_FAILED REQUEST_UPDATE failed on this subscription (see Section 9.10). §9.13
0x9 EXCESSIVE_LOAD The publisher is overloaded and is terminating the subscription. §9.13
0x12 MALFORMED_TRACK A relay publisher detected that the track was malformed (see Section 2.4.2). §9.13
0x7f * N + 0x9D Reserved for greasing Reserved — the draft assigns no meaning to this range. §14.5.3

11 code points from table-15 of draft-17 (§14.5.3. PUBLISH_DONE Codes).

Data Stream Reset Error Codes

Section titled “Data Stream Reset Error Codes”

draft-17 registers 9 code points in §14.5.4, and defines each one in §10.4.3.

Code Name Description Defined in
0x0 INTERNAL_ERROR An implementation specific error. §10.4.3
0x1 CANCELLED The subscriber or publisher cancelled the Request. For Subscriptions, PUBLISH_DONE (Section 9.13) will have a more detailed status code. §10.4.3
0x2 DELIVERY_TIMEOUT The DELIVERY TIMEOUT Section 9.3.3 was exceeded for this stream. §10.4.3
0x3 SESSION_CLOSED The publisher session is being closed. §10.4.3
0x4 UNKNOWN_OBJECT_STATUS In response to a FETCH, the publisher is unable to determine the Status of the next Object in the requested range. §10.4.3
0x5 TOO_FAR_BEHIND The corresponding subscription has exceeded the publisher's resource limits and is being terminated (see Section 9.3.3). §10.4.3
0x9 EXCESSIVE_LOAD The publisher is overloaded and is resetting this stream. §10.4.3
0x12 MALFORMED_TRACK A relay publisher detected that the track was malformed (see Section 2.4.2). §10.4.3
0x7f * N + 0x9D Reserved for greasing Reserved — the draft assigns no meaning to this range. §14.5.4

9 code points from table-16 of draft-17 (§14.5.4. Data Stream Reset Error Codes).

Object Status

Section titled “Object Status”

Object Status is a second family of code points and is counted on its own. It is the status a single Object carries, not the outcome of a request or a session, so its 3 values are never added to the 59 above. In draft-17 it has no IANA registry — the same code points are assigned as prose in the section that defines the field.

Code Name Description
0x0 NORMAL —
0x3 END_OF_GROUP —
0x4 END_OF_TRACK —

Payload rule: Any object with a status code other than zero MUST have an empty payload.

Where these numbers come from

Section titled “Where these numbers come from”

The code points, names and registry membership come from crates/moqtap-codec/tools/registries/draft-17.json, a committed extraction of draft-ietf-moq-transport-17 produced by crates/moqtap-codec/tools/extract-registries.py. The moqtap Rust codec's conformance tests read that same file and compare it against the crate's enums in both directions, so a code point this page shows and the codec refuses is a test failure, not a documentation drift.

That extraction records source_sha256, the SHA-256 of the rendered draft as bytes on disk: 64d2e8f543c4d9bcf998d36bf805a752d89d4e02d14082ef4d73258e65a8c1d7. The descriptions and section links on this page are read from spec-sources/draft-17.html in this site's repository, whose hash matches — the two inputs are provably the same document.

Read draft-17 section by section, or go to the draft-17 control message types.

Error codes in other drafts

Section titled “Error codes in other drafts”

moqtap covers drafts 07 through 20.

All MoQT error codes, draft by draft · Control message types