Internet-Draft | moq-test | March 2025 |
Frindell | Expires 4 September 2025 | [Page] |
This document specifies the moq-test protocol, a testing protocol for Media over QUIC (MOQ) implementations. moq-test utilizes the Track Namespace as parameters to the publisher, enabling flexible and customizable testing scenarios.¶
This note is to be removed before publishing as an RFC.¶
The latest revision of this draft can be found at https://afrind.github.io/moq-test/draft-afrind-moq-test.html. Status information for this document may be found at https://datatracker.ietf.org/doc/draft-afrind-moq-test/.¶
Discussion of this document takes place on the Media Over QUIC mailing list (mailto:moq@ietf.org), which is archived at https://mailarchive.ietf.org/arch/browse/moq/. Subscribe at https://www.ietf.org/mailman/listinfo/moq/.¶
Source for this draft and an issue tracker can be found at https://github.com/afrind/moq-test.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 4 September 2025.¶
Copyright (c) 2025 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
moq-test is designed to provide a comprehensive testing framework for MOQ implementations. By leveraging the Track Namespace, moq-test allows testers to specify various parameters that control the testing process, such as forwarding preferences, group and object ranges, and object sizes.¶
The moq-test protocol utilizes the Track Namespace to convey testing parameters from the publisher to the subscriber. The Track Namespace tuple fields are defined as follows. Exactly 16 tuple fields must be provided, but any blank tuple field other than field 0 indicates the default value is used. Future versions will use a different value for tuple field 0 and potentially define a different set of parameters.¶
This field indicates that the Track Namespace parameters are for the moq-test protocol.¶
This field specifies the forwarding preference for the track. The following values are defined:¶
0 := One subgroup per group¶
1 := One subgroup per object¶
2 := Two subgroups per group (0 and 1)¶
3 := Datagram¶
The default value is 0. When using two subgroups per group, even numbered objects are sent on subgroup 0 and odd numbered objects are sent on group 1.¶
This field specifies the starting group number for the track. The default value is 0.¶
This field specifies the starting object number for the track. The default value is 0.¶
This field specifies the last group number in the track. The default value is 2^62 - 1 (eg: the track continues until unsubscribed).¶
Use caution when setting this field accessing this track via FETCH.¶
This field specifies the last object number in the track. The maximum value is the number of objects in the group, plus one if end of group markers are used.¶
The default value is the maximum value.¶
This field specifies the number of objects per group. The default is 10.¶
This field specifies the size of the first object in bytes. The default is 1024 bytes.¶
This specifies the size of objects with ID greater than 0, in bytes. The default value is 100 bytes.¶
This field specifies the frequency at which objects are sent in milliseconds. The default value is 1000.¶
This field specifies the increment between group numbers. The default is 1.¶
This tuple field specifies the increment between object numbers. The default is 1.¶
This field specifies whether to send end of group markers.¶
End of group markers are an Object with status 0x3 End of Group.¶
The default value is 0 / No End of Group markers.¶
This field specifies whether to include a test integer extension on every object in the track. The ID of the extension is 2 * field value. The value of the extension is random.¶
The default value indicates no integer extension is sent.¶
This field specifies whether to include a test variable extension on every object in the track. The ID of the extension is 2 * field value + 1. The value of the extension is random data.¶
The default value indicates no variable extension is sent.¶
This field specifies the publisher delivery timeout in milliseconds. The default is no delivery timeout.¶
If any namespace tuple field other than zero is not a positive integer, or is outside the supported range of the publisher, a SUBSCRIBE_ERROR or FETCH_ERROR is returned.¶
Upon receiving a vald SUBSCRIBE or FETCH for a moq-test track, the publisher MUST publish objects according to the parameters of the namespace.¶
The payload of each published object is the charater t (for test) repeated for the length of the payload.¶
When Datagram forwarding preference is used, certain combinations of options result in objects that cannot be transmitted below the maximum datagram size. The publisher either responds with SUBSCRIBE_ERROR if detected when handling the SUBSCRIBE, or SUBSCRIBE_DONE with an error code if detected when publishing the object.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The subscriber can generate an asymmetric amount of work on the server. Servers SHOULD set limits on certain values such as object frequency and object size to prevent resource exhaustion attacks.¶
This document has no IANA actions.¶
Members of the Media over QUIC working group¶