CLUE Messages
Namespace for CLUE Messages
urn:ietf:params:xml:ns:clue-protocol
See
RFC 8847.
12.2. XML Schema Registration
This section registers an XML schema per the guidelines in [RFC3688].
URI: urn:ietf:params:xml:schema:clue-protocol
Registrant Contact: IESG (iesg@ietf.org).
Schema: The XML for this schema can be found in Section 9 of this
document.
12.3. Media Type Registration for "application/clue+xml"
This section registers the "application/clue+xml" media type.
To: ietf-types@iana.org
Subject: Registration of media type "application/clue+xml"
Media type name: application
Subtype name: clue+xml
Required parameters: (none)
Optional parameters: charset. Same as the charset parameter of
"application/xml" as specified in [RFC7303], Section 4.2.
Encoding considerations: Same as the encoding considerations of
"application/xml" as specified in [RFC7303], Section 4.2.
Security considerations: This content type is designed to carry
protocol data related to telepresence session control. Some of
the data could be considered private. This media type does not
provide any protection; thus, other mechanisms, such as those
described in Section 11 of this document, are required to protect
the data. This media type does not contain executable content.
Interoperability considerations: None.
Published specification: RFC 8847
Applications that use this media type: CLUE Participants.
Additional Information:
Magic Number(s): (none)
File extension(s): .xml
Macintosh File Type Code(s): TEXT
Person & email address to contact for further information: Simon
Pietro Romano (spromano@unina.it).
Intended usage: LIMITED USE
Author/Change controller: The IETF
Other information: This media type is a specialization of
application/xml [RFC7303], and many of the considerations
described there also apply to application/clue+xml.
12.4. CLUE Protocol Registry
Per this document, IANA has created new registries for CLUE messages
and response codes.
12.4.1. CLUE Message Types
The following summarizes the registry for CLUE messages:
Related Registry: CLUE Message Types
Defining RFC: RFC 8847
Registration/Assignment Procedures: Following the policies outlined
in [RFC8126], the IANA policy for assigning new values for the
CLUE message types for the CLUE protocol is Specification
Required.
Registrant Contact: IESG (iesg@ietf.org).
The initial table of CLUE messages is populated using the CLUE
messages described in Section 5 and defined in the XML schema in
Section 9.
+===================+=================================+===========+
| Message | Description | Reference |
+===================+=================================+===========+
| options | Sent by the CI to the CR in the | RFC 8847 |
| | initiation phase to specify the | |
| | roles played by the CI, the | |
| | supported versions, and the | |
| | supported extensions. | |
+-------------------+---------------------------------+-----------+
| optionsResponse | Sent by the CI to the CR in | RFC 8847 |
| | reply to an 'options' message, | |
| | to establish the version and | |
| | extensions to be used in the | |
| | subsequent exchange of CLUE | |
| | messages. | |
+-------------------+---------------------------------+-----------+
| advertisement | Sent by the MP to the MC to | RFC 8847 |
| | specify the telepresence | |
| | capabilities of the MP | |
| | expressed according to the CLUE | |
| | framework. | |
+-------------------+---------------------------------+-----------+
| ack | Sent by the MC to the MP to | RFC 8847 |
| | acknowledge the reception of an | |
| | 'advertisement' message. | |
+-------------------+---------------------------------+-----------+
| configure | Sent by the MC to the MP to | RFC 8847 |
| | specify the desired media | |
| | captures among those specified | |
| | in the 'advertisement'. | |
+-------------------+---------------------------------+-----------+
| configureResponse | Sent by the MP to the MC in | RFC 8847 |
| | reply to a 'configure' message | |
| | to communicate whether or not | |
| | the configuration request has | |
| | been successfully processed. | |
+-------------------+---------------------------------+-----------+
Table 2: Initial IANA Table of CLUE Messages
12.4.2. CLUE Response Codes
The following summarizes the registry for CLUE response codes:
Related Registry: CLUE Response Codes
Defining RFC: RFC 8847
Registration/Assignment Procedures: Following the policies outlined
in [RFC8126], the IANA policy for assigning new values for the
response codes for CLUE is Specification Required.
Registrant Contact: IESG (iesg@ietf.org).
The initial table of CLUE response codes is populated using the
response codes defined in Section 5.7 as follows:
+========+===============+==============================+===========+
| Number | Default | Description | Reference |
| | Reason String | | |
+========+===============+==============================+===========+
| 200 | Success | The request has been | RFC 8847 |
| | | successfully | |
| | | processed. | |
+--------+---------------+------------------------------+-----------+
| 300 | Low-level | A generic low-level | RFC 8847 |
| | request error | request error has | |
| | | occurred. | |
+--------+---------------+------------------------------+-----------+
| 301 | Bad syntax | The XML syntax of the | RFC 8847 |
| | | message is not | |
| | | correct. | |
+--------+---------------+------------------------------+-----------+
| 302 | Invalid value | The message contains | RFC 8847 |
| | | an invalid parameter | |
| | | value. | |
+--------+---------------+------------------------------+-----------+
| 303 | Conflicting | The message contains | RFC 8847 |
| | values | values that cannot be | |
| | | used together. | |
+--------+---------------+------------------------------+-----------+
| 400 | Semantic | The received CLUE | RFC 8847 |
| | errors | protocol message | |
| | | contains semantic | |
| | | errors. | |
+--------+---------------+------------------------------+-----------+
| 401 | Version not | The protocol version | RFC 8847 |
| | supported | used in the message is | |
| | | not supported. | |
+--------+---------------+------------------------------+-----------+
| 402 | Invalid | The received message | RFC 8847 |
| | sequencing | contains an unexpected | |
| | | sequence number (e.g., | |
| | | sequence number gap, | |
| | | repeated sequence | |
| | | number, or sequence | |
| | | number outdated). | |
+--------+---------------+------------------------------+-----------+
| 403 | Invalid | The clueId used in the | RFC 8847 |
| | identifier | message is invalid or | |
| | | unknown. | |
+--------+---------------+------------------------------+-----------+
| 404 | Advertisement | The sequence number of | RFC 8847 |
| | expired | the advertisement the | |
| | | 'configure' message | |
| | | refers to is out of | |
| | | date. | |
+--------+---------------+------------------------------+-----------+
| 405 | Subset choice | The subset choice is | RFC 8847 |
| | not allowed | not allowed for the | |
| | | specified Multiple | |
| | | Content Capture. | |
+--------+---------------+------------------------------+-----------+
Table 3: Initial IANA Table of CLUE Response Codes
13. References
13.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
.
[RFC3550] Schulzrinne, H., Casner, S., Frederick, R., and V.
Jacobson, "RTP: A Transport Protocol for Real-Time
Applications", STD 64, RFC 3550, DOI 10.17487/RFC3550,
July 2003, .
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
.
[RFC7303] Thompson, H. and C. Lilley, "XML Media Types", RFC 7303,
DOI 10.17487/RFC7303, July 2014,
.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, .
[RFC8845] Duckworth, M., Ed., Pepperell, A., and S. Wenger,
"Framework for Telepresence Multi-Streams", RFC 8845,
DOI 10.17487/RFC8845, January 2021,
.
[RFC8846] Presta, R. and S P. Romano, "An XML Schema for the
Controlling Multiple Streams for Telepresence (CLUE) Data
Model", RFC 8846, DOI 10.17487/RFC8846, January 2021,
.
[RFC8848] Hanton, R., Kyzivat, P., Xiao, L., and C. Groves, "Session
Signaling for Controlling Multiple Streams for
Telepresence (CLUE)", RFC 8848, DOI 10.17487/RFC8848,
January 2021, .
[RFC8850] Holmberg, C., "Controlling Multiple Streams for
Telepresence (CLUE) Protocol Data Channel", RFC 8850,
DOI 10.17487/RFC8850, January 2021,
.
[W3C.REC-xml-20081126]
Bray, T., Paoli, J., Sperberg-McQueen, M., Maler, E., and
F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
Edition)", World Wide Web Consortium Recommendation REC-
xml-20081126, November 2008,
.
13.2. Informative References
[RFC1122] Braden, R., Ed., "Requirements for Internet Hosts -
Communication Layers", STD 3, RFC 1122,
DOI 10.17487/RFC1122, October 1989,
.
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", RFC 3261,
DOI 10.17487/RFC3261, June 2002,
.
[RFC4353] Rosenberg, J., "A Framework for Conferencing with the
Session Initiation Protocol (SIP)", RFC 4353,
DOI 10.17487/RFC4353, February 2006,
.
[RFC6120] Saint-Andre, P., "Extensible Messaging and Presence
Protocol (XMPP): Core", RFC 6120, DOI 10.17487/RFC6120,
March 2011, .
[RFC7262] Romanow, A., Botzko, S., and M. Barnes, "Requirements for
Telepresence Multistreams", RFC 7262,
DOI 10.17487/RFC7262, June 2014,
.
[RFC7667] Westerlund, M. and S. Wenger, "RTP Topologies", RFC 7667,
DOI 10.17487/RFC7667, November 2015,
.
Acknowledgements
The authors thank all the CLUErs for their precious feedback and
support -- in particular, Paul Kyzivat, Christian Groves, and
Scarlett Liuyan.
Authors' Addresses
Roberta Presta
University of Napoli
Via Claudio 21
80125 Napoli
Italy
Email: roberta.presta@unina.it
Simon Pietro Romano
University of Napoli
Via Claudio 21
80125 Napoli
Italy
Email: spromano@unina.it
gemini://gemini.bortzmeyer.org/rfc-mirror/rfc8847.txt -- Leo's gemini proxy
-- Connecting to gemini.bortzmeyer.org:1965...
-- Connected
-- Sending request
-- Meta line: 20 text/plain
-- Response ended
-- Page fetched on Mon May 6 23:45:18 2024