diff --git a/xep-0177.xml b/xep-0177.xml index 8a4c1f75..77002430 100644 --- a/xep-0177.xml +++ b/xep-0177.xml @@ -10,7 +10,7 @@ This document defines a Jingle transport method that results in sending data over a raw User Datagram Protocol (UDP) connection. &LEGALNOTICE; 0177 - Proposed + Experimental Standards Track Standards JIG Council @@ -20,29 +20,35 @@ - raw-udp + TO BE ASSIGNED &joebeda; &stpeter; &scottlu; &hildjj; &seanegan; + + 0.4 + 2006-12-21 + psa +

Recommended sending of candidate in initiation request to save a round trip and expedite the negotiation; removed name attribute; clarified flow of negotiation; modified spec to use provisional namespace before advancement to Draft (per XEP-0053).

+
0.3 2006-10-31 psa - Added informational messages; clarified connectivity checks and acceptance process; mentioned that the Raw UDP candidate is conceptually equivalent to the concept of an in-use candidate from the ICE specification; added reference to RFC 4347. +

Added informational messages; clarified connectivity checks and acceptance process; mentioned that the Raw UDP candidate is conceptually equivalent to the concept of an in-use candidate from the ICE specification; added reference to RFC 4347.

0.2 2006-07-12 se/psa - Removed candidate element and specified exchange of address information via transport-info messages; clarified usage of name attribute. +

Removed candidate element and specified exchange of address information via transport-info messages; clarified usage of name attribute.

0.1 2006-03-01 psa/jb - Initial version (split from XEP-0166). +

Initial version (split from XEP-0166).

@@ -51,73 +57,113 @@

The Jingle transport method defined herein is designed to meet the following requirements:

    -
  1. Make it possible to establish and manage out-of-band connections between two XMPP entities over the IP address and port that the initiator considers most likely to succeed.
  2. +
  3. Make it possible to establish and manage out-of-band connections between two XMPP entities over the IP address and port that the parties consider most likely to succeed.
  4. Make it relatively easy to implement support in standard Jabber/XMPP clients.
  5. Where communication with non-XMPP entities is needed, push as much complexity as possible onto server-side gateways between the XMPP network and the non-XMPP network.

Note: The Raw UDP transport does not provide traversal of Network Address Translators (NATs) and is provided only for the purpose of specifying the IP address and port that an entity considers most likely to succeed without the need for NAT traversal. If NAT traversal is needed, &xep0176; SHOULD be used.

- -

In order for the initiating entity in a Jingle exchange to start the negotiation, it MUST send a Jingle "session-initiate" stanza as described in XEP-0166. This stanza MUST include at least one transport methods. If the initiating entity wishes to negotiate the Raw UDP transport, it MUST include an empty &TRANSPORT; child element qualified by the 'http://jabber.org/protocol/jingle/transport/raw-udp' namespace.

+ +

In order for the initiating entity in a Jingle exchange to start the negotiation, it MUST send a Jingle "session-initiate" stanza as described in XEP-0166. This stanza MUST include at least one content type. If the initiating entity wishes to negotiate the Raw UDP transport for a given content type, it MUST include a &TRANSPORT; child element qualified by the 'http://www.xmpp.org/extensions/xep-0177.html#ns' namespace (see Protocol Namespaces), which MUST This is required to avoid a round trip and help expedite the negotiation. include the initiating entity's Raw UDP candidate via the 'ip', 'port', 'generation', and 'name' attributes of the &CANDIDATE; element.

- + - + - - - - - ]]> -
- -

As described in XEP-0166, to provisionally accept the session initiation request, the receiver returns an IQ-result:

- - ]]> -
- -

Once the session is provisionally accepted, each entity SHOULD send one &TRANSPORT; element in a transport-info meessage, containing exactly one &CANDIDATE; element per content type, whose 'ip' and 'port' attributes specify the IP address and port number of the candidate that the initiator has reason to believe will be most likely to succeed for that content type. This is not necessarily the initiator's preferred address for communication, but instead is the "address most likely to succeed", i.e., the address that is assumed to be reachable by the vast majority of target entities. To determine reachability, the client needs classify ahead of time the permissiveness of the NAT or firewall it is behind, if any. If the NAT is symmetric (not permissive), the candidate SHOULD specify a relay address. Otherwise it SHOULD be an address derived via prior discovery using &rfc3489;, which will be an address on the outside of the firewall or NAT.

-

Note: The Raw UDP candidate is equivalent to the "in-use" candidate as described in &ice;. (In older versions of XEP-0166, this was referrred to as the "default candidate".)

- - - - - + + ]]> -

The 'generation', 'ip', 'name', and 'port' attributes are REQUIRED. The 'name' attribute specifies the name of the content type and the 'generation' attribute provides a tracking mechanism for determining which version of this candidate is in force (this is useful if the candidate is redefined mid-stream, for example if the port is changed).

-

Either entity may send this "transport-info" action at any time, after which the recipient should attempt to send media data to the specified address (either entity MAY also send the Informational Messages described below). If media data can be delivered for the candidate, the recipient MUST send a Jingle "transport-accept" action to the initiator (either explicitly, or implicitly via a "content-accept" or "session-accept" action.

- The 'generation', 'ip', and 'port' attributes are REQUIRED. The 'ip' and 'port' attributes are self-explanatory. The 'generation' attribute provides a tracking mechanism for determining which version of this candidate is in force (this is useful if the candidate is redefined mid-stream, for example if the port is changed).

+

Note: The "Raw UDP candidate" is the candidate that the entity has reason to believe will be most likely to succeed for that content type, and thus is equivalent to the "in-use" candidate as described in &ice;. In older versions of XEP-0166, this was referrred to as the "default candidate". This is not necessarily the entity's preferred address for communication, but instead is the "address most likely to succeed", i.e., the address that is assumed to be reachable by the vast majority of target entities. To determine reachability, the client needs classify ahead of time the permissiveness of the NAT or firewall it is behind, if any. It then SHOULD assign the Raw UDP candidate as follows, where the candidate types are as described in ICE:

+ + + + + + + + + + + + + + + + + +
NAT TypeRecommended Raw UDP Candidate Type
NoneHost candidate
Symmetric (not permissive)Relay candidate
PermissiveServer reflexive or peer reflexive candidate discovered via &rfc3489;
+
+ +

As described in XEP-0166, to provisionally accept the session initiation request, the receiver returns an IQ-result:

+ + ]]> +

Once the receiving entity provisionally accepts the session, it:

+
    +
  • MUST check the initiating entity's Raw UDP candidate by attempting to send media data to the specified IP and port.
  • +
  • SHOULD send its own Raw UDP candidate to the initiating entity via a Jingle "transport-info" message.
  • +
  • MAY send an informational message.
  • +
+

These are done simultaneously in order to ensure that a connection can be made, since the initiating entity's Raw UDP candidate may not result in success.

+ +

The receiving entity MUST immediately attempt to send media data to the IP and port specified in the initiation request. If media data can be delivered, the recipient MUST send a Jingle "transport-accept" action to the initiator (either explicitly, or implicitly via a "content-accept" or "session-accept" action.

+ - - - + + - ]]> -

The initiator MUST then acknowledge acceptance by returning an IQ result (or return a standard XMPP error).

+ ]]> +

The initiating entity MUST then acknowledge acceptance by returning an IQ result (or return a standard XMPP error).

+ + ]]> +
+ +

While checking the initiating entity's Raw UDP candidate, the receiving entity SHOULD its own Raw UDP candidate to the initiating entity by sending a transport-info message to the initiating entity, as shown in the following example.

+ + + + + + + + + + ]]> +

The initiating entity MUST then acknowledge receipt by returning an IQ result (or return a standard XMPP error).

+ + ]]> +

Naturally, the intiating entity then MUST also check the receiving entity's Raw UDP candidate by following the checking procedure outlined above.

+
+ +

While checking the initiating entity's Raw UDP candidate, the receiving entity MAY send an informational message to communicate the status of transport checking. The informational message MUST be an IQ-set containing a &JINGLE; element of type "transport-info", where the informational message is a payload element specified in the Informational Messages section of this document.

+
-

Informational messages may be sent by the receiver within the context of the Raw UDP transport to communicate the status of transport checking. The informational message MUST be an IQ-set containing a &JINGLE; element of type "transport-info", where the informational message is a payload element qualified by the 'http://jabber.org/protocol/jingle/info/raw-udp' namespace; the following payload elements are defined:

+

Informational messages MAY be sent by the receiver within the context of the Raw UDP transport to communicate the status of transport checking. The informational message MUST be an IQ-set containing a &JINGLE; element of type "transport-info", where the informational message is a payload element qualified by the 'http://www.xmpp.org/extensions/xep-0177.html#ns-info' namespace (see Protocol Namespaces). The following payload elements are defined:

@@ -151,12 +197,11 @@ - -

The ®ISTRAR; shall include 'http://jabber.org/protocol/jingle/transport/raw-udp' in its registry of protocol namespaces.

+ +

Until this specification advances to a status of Draft, its associated namespaces shall be "http://www.xmpp.org/extensions/xep-0177.html#ns" and "http://www.xmpp.org/extensions/xep-0177.html#ns-info"; upon advancement of this specification, the ®ISTRAR; shall issue permanent namespaces in accordance with the process defined in Section 4 of &xep0053;.

-

The XMPP Registrar shall include "http://jabber.org/protocol/jingle/transport/raw-udp" in its registry of Jingle transport methods. The registry submission is as follows:

- ®PROCESS; +

The XMPP Registrar shall include "raw-udp" in its registry of Jingle transport methods. The registry submission is as follows:

raw-udp @@ -172,8 +217,8 @@ @@ -189,7 +234,6 @@ - diff --git a/xep-0180.xml b/xep-0180.xml index 42f5352a..58911137 100644 --- a/xep-0180.xml +++ b/xep-0180.xml @@ -20,13 +20,19 @@ - jingle-video + TO BE ASSIGNED &stpeter; Milton Chen Milton.Chen@vseelab.com + + 0.4 + 2006-12-21 + psa +

Modified spec to use provisional namespace before advancement to Draft (per XEP-0053).

+
0.3 2006-08-23 @@ -66,7 +72,7 @@

A Jingle video session is described by one or more encodings contained within a wrapper &DESCRIPTION; element. In the language of RFC 4566 these encodings are payload-types; therefore, each <payload-type/> child element specifies an encoding that can be used for the video stream. Such encodings are often used in the context of the Real-time Transfer Protocol (RTP; see &rfc3550;) but may be used in other contexts as well. The most common encodings for the Audio/Video Profile (AVP) of RTP are listed in &rfc3551; (these "static" types are reserved from payload ID 0 through payload ID 96), although other encodings are allowed (these "dynamic" types use payload IDs 97 to 127) in accordance with the dynamic assignment rules described in Section 3 of RFC 3551. The &PAYLOADTYPE; element's 'id' attribute is REQUIRED and its 'name' attribute is RECOMMENDED. The encodings SHOULD be provided in order of preference.

+ @@ -132,7 +138,7 @@

To follow.

-

If an entity supports the Jingle video content description format, it MUST advertise that fact by returning a feature of "http://jabber.org/protocol/jingle/description/video" in response to &xep0030; information requests.

+

If an entity supports the Jingle video content description format, it MUST advertise that fact by returning a feature of "http://www.xmpp.org/extensions/xep-0166.html#ns/description/video" in response to &xep0030; information requests.

... - - + + ... ]]>
-

Informational messages may be sent by either party within the context of Jingle to communicate the status of a Jingle video session, device, or principal. The informational message MUST be an IQ-set containing a &JINGLE; element of type "content-info", where the informational message is a payload element qualified by the 'http://jabber.org/protocol/jingle/info/video' namespace. No payload elements have yet been defined, but will be specified in a future version of this document.

+

Informational messages may be sent by either party within the context of Jingle to communicate the status of a Jingle video session, device, or principal. The informational message MUST be an IQ-set containing a &JINGLE; element of type "content-info", where the informational message is a payload element qualified by the 'http://www.xmpp.org/extensions/xep-0166.html#ns/info/video' namespace. No payload elements have yet been defined, but will be specified in a future version of this document.

@@ -170,16 +176,16 @@

This document requires no interaction with &IANA;.

- -

The ®ISTRAR; shall include 'http://jabber.org/protocol/jingle/description/video' and 'http://jabber.org/protocol/jingle/info/video' in its registry of protocol namespaces.

+ +

Until this specification advances to a status of Draft, its associated namespaces shall be "http://www.xmpp.org/extensions/xep-0180.html#ns" and "http://www.xmpp.org/extensions/xep-0180.html#ns-info"; upon advancement of this specification, the ®ISTRAR; shall issue permanent namespaces in accordance with the process defined in Section 4 of &xep0053;.

-

The XMPP Registrar shall include the name "video" in its registry of Jingle content description formats. The registration is as follows:

+

The XMPP Registrar shall include "video" in its registry of Jingle content description formats. The registry submission is as follows:

video Jingle sessions that support video exchanges - XEP-xxxx + XEP-0180 ]]>
@@ -191,8 +197,8 @@
Element