moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-24 18:22:24 -05:00
Code Issues Releases Wiki Activity

0.10

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1385 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-11-15 23:58:53 +00:00
parent 031794d286
commit 67123e3f2c
1 changed files with 33 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
xep-0176.xml
View File

@ -28,6 +28,12 @@
&scottlu;
&hildjj;
&seanegan;
<revision>
<version>0.10</version>
<date>2007-11-15</date>
<initials>psa</initials>
<remark><p>Editorial review and consistency check.</p></remark>
</revision>
<revision>
<version>0.9</version>
<date>2007-06-28</date>
@ -84,8 +90,8 @@
</revision>
</header>
<section1 topic='Introduction' anchor='intro'>
<p><em>Note: This document depends on the IETF's &ice; and &icetcp; specifications, which are works in progress. Every effort has been made to keep this document synchronized with <cite>draft-ietf-mmusic-ice</cite> and <cite>draft-ietf-mmusic-ice-tcp</cite>. The interested reader is referred to &icecore; for a detailed description of the ICE methodology, which for the most part this document merely maps to XMPP syntax.</em></p>
<p>&xep0166; defines a framework for negotiating and managing out-of-band data sessions over XMPP. In order to provide a flexible framework, the base Jingle specification defines neither data transport methods nor content formats, leaving that up to separate specifications. The current document defines two transport methods (ice-udp and ice-tcp) for establishing and managing data connections between XMPP entities, using the ICE methodology currently being developed within the IETF. The ice-udp method results in a lossy transport suitable for use in media applications where some packet loss is tolerable (e.g., audio and video), whereas the ice-tcp method results in a reliable transport suitable for use in applications where packet loss is not tolerable (e.g., file transfer).</p>
<p><em>Note: This document depends on the IETF's specifications for &ice; and &ice-tcp; (the former has been approved but the latter is still a work in progress). Every effort has been made to keep this document synchronized with <cite>draft-ietf-mmusic-ice</cite> and <cite>draft-ietf-mmusic-ice-tcp</cite>. The interested reader is referred to &icecore; for a detailed description of the ICE methodology, which for the most part this document merely maps to XMPP syntax.</em></p>
<p>&xep0166; defines a framework for negotiating and managing out-of-band data sessions over XMPP. In order to provide a flexible framework, the base Jingle specification defines neither data transport methods nor application formats, leaving that up to separate specifications. The current document defines two transport methods (ice-udp and ice-tcp) for establishing and managing data connections between XMPP entities, using the ICE methodology developed within the IETF. The ice-udp method results in a lossy transport suitable for use in media applications where some packet loss is tolerable (e.g., audio and video), whereas the ice-tcp method results in a reliable transport suitable for use in applications where packet loss is not tolerable (e.g., file transfer).</p>
<p>The process for ICE negotiation is largely the same in Jingle as it is in ICE. There are several differences:</p>
<ul>
<li>Instead of using SIP as the signalling channel, Jingle uses XMPP as the signalling channel.</li>
@ -109,14 +115,14 @@
<p>In accordance with Section 8 of <cite>XEP-0166</cite>, this document specifies the following information related to the Jingle ice-udp and ice-tcp transport methods:</p>
<ol>
<li><p>The transport negotiation process is defined in the <link url='#protocol'>Protocol Description</link> section of this document.</p></li>
<li><p>The semantics of the &DESCRIPTION; element are defined in the <link url='#protocol-negotiate'>ICE Negotiation</link> section of this document.</p></li>
<li><p>The semantics of the &TRANSPORT; element are defined in the <link url='#protocol-negotiate'>ICE Negotiation</link> section of this document.</p></li>
<li><p>Successful negotiation of the ice-udp method results in use of a lossy transport that is suitable for applications where some packet loss is tolerable, such as audio and video; successful negotiation of the ice-tcp method results in use of a reliable transport that is suitable for applications where packet loss is not tolerable, such as file transfer.</p></li>
<li><p>If multiple components are to be communicated over the transport in the context of the Real-time Transport Protocol (RTP; see &rfc3550;), the component numbered "1" shall be associated with RTP and the component numbered "2" shall be associated with the Real Time Control Protocol (RTCP).</p></li>
</ol>
</section1>
<section1 topic='Protocol Description' anchor='protocol'>
<section2 topic='Transport Initiation' anchor='protocol-initiate'>
<p>In order for the initiator in a Jingle exchange to start the negotiation, it MUST send a Jingle "session-initiate" stanza as described in <cite>XEP-0166</cite>. This stanza MUST include at least one transport method. If the initiator wishes to negotiate the ice-udp or ice-tcp transport, it MUST include an empty &TRANSPORT; child element qualified by the 'http://www.xmpp.org/extensions/xep-0176.html#ns-udp' or 'http://www.xmpp.org/extensions/xep-0176.html#ns-tcp' namespace &NSNOTE;.</p>
<p>In order for the initiator in a Jingle exchange to start the negotiation, it MUST send a Jingle "session-initiate" stanza as described in <cite>XEP-0166</cite>. A content type MUST include one transport method. If the initiator wishes to negotiate the ice-udp or ice-tcp transport for an application format, it MUST include an empty &TRANSPORT; child element qualified by the 'http://www.xmpp.org/extensions/xep-0176.html#ns-udp' or 'http://www.xmpp.org/extensions/xep-0176.html#ns-tcp' namespace &NSNOTE;.</p>
<example caption="Initiation"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='jingle1'
@ -126,9 +132,9 @@
action='session-initiate'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content name='this-is-the-audio-content'>
<content name='this-is-the-audio-content' profile='RTP/AVP'>
<description xmlns='http://www.xmpp.org/extensions/xep-0167.html#ns'>
...
[ ... ]
</description>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'/>
</content>
@ -138,7 +144,7 @@
</section2>
<section2 topic='Receiver Response' anchor='protocol-response'>
<p>As described in <cite>XEP-0166</cite>, to provisionally accept the session initiation request, the responder returns an IQ-result:</p>
<example caption="Receiver Provisionally Accepts the Session Request"><![CDATA[
<example caption="Receiver provisionally accepts the session request"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='jingle1'
to='romeo@montague.net/orchard'
@ -147,10 +153,11 @@
</section2>
<section2 topic='ICE Negotiation' anchor='protocol-negotiate'>
<p>If the responder provisionally accepts the session initiation request as shown above, both initiator and responder MUST immediately negotiate connectivity over the ICE transport by exchanging XML-formatted candidate transports for the channel. This negotiation proceeds immediately in order to maximize the possibility that media can be exchanged as quickly as possible. <note>Concurrent with negotiation of the ICE candidates, it is possible for the initiator and responder to negotiate which content types the session will include, which transport methods will be tried for each content type, etc. Those negotiation flows are shown in <cite>XEP-0166</cite>. This document specifies only negotiation of the ICE transport method.</note></p>
<p>Note: In order to expedite session establishment, the initiator MAY send transport candidates immediately after sending the "session-initiate" message and before receiving acknowledgement from the receiver (i.e., the initiator MUST consider the session to be live even before receiving acknowledgement). Given in-order delivery, the receiver should receive such "transport-info" messages after receiving the "session-initiate" message; if not, it is appropriate for the receiver to return &lt;unknown-session/&gt; errors since it according to its state machine the session does not exist. If either party receives an &lt;unknown-session/&gt; from the other party, it MUST terminate the negotiation and the session.</p>
<p>The candidate syntax and negotiation flow are described below. (This document shows negotiation for the ice-udp transport method, but the same principles apply to the ice-tcp transport method.)</p>
<section3 topic='Syntax of Candidate Element' anchor='protocol-negotiate-candidate'>
<p>The following is an example of the candidate format:</p>
<example caption="Initiator Sends a Candidate Transport"><![CDATA[
<example caption="Initiator sends a candidate transport"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='info1'
to='juliet@capulet.com/balcony'
@ -159,7 +166,7 @@
action='transport-info'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
<candidate component='1'
foundation='1'
@ -257,12 +264,11 @@
</section3>
<section3 topic='Negotiation Flow' anchor='protocol-negotiate-flow'>
<p>The first step in negotiating connectivity is for both parties to immediately begin sending candidate transport methods to the other client. <note>The fact that both parties send candidates means that Jingle requires each party to be a full implementation of ICE, not a "lite" implementation as specified in &icecore;.</note> These candidates SHOULD be gathered by following the procedure specified in Section 4.1.1 of &icecore; and prioritized by following the procedure specified in Section 4.1.2 of &icecore;. Each candidate MUST be sent in a &JINGLE; element with an action of "transport-info".</p>
<p>If the responder receives and can successfully process a given candidate, it returns an IQ-result (if not, for example because the candidate data is improperly formatted, it returns an error).</p>
<p>Note: The responder is only indicating receipt of the candidate, not telling the initiator that the candidate will be used.</p>
<p>If the responder receives and can successfully process a given candidate, it returns an IQ-result (if not, for example because the candidate data is improperly formatted, it returns an error). Note: The responder is only indicating receipt of the candidate, not telling the initiator that the candidate will be used.</p>
<p>The initiator keeps sending candidates, one after the other (without stopping to receive an acknowledgement of receipt from the responder for each candidate) until it has exhausted its supply of possible or desirable candidate transports. (Because certain candidates may be more "expensive" in terms of bandwidth or processing power, the initiator may not want to advertise their existence unless necessary.) For each candidate, the responder acknowledges receipt.</p>
<p>At the same time (i.e., immediately after provisionally accepting the session, not waiting for the initiator to begin or finish sending candidates), the responder also begins sending candidates that may work for it. As above, the initiator acknowledges receipt of the candidates.</p>
<p>As the initiator and responder receive candidates, they probe the various candidate transports for connectivity. In performing these connectivity checks, a client SHOULD follow the procedure specified in Section 7 of &icecore;.</p>
<example caption="Initiator Sends a Candidate"><![CDATA[
<example caption="Initiator sends a candidate"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='info1'
to='juliet@capulet.com/balcony'
@ -271,7 +277,7 @@
action='transport-info'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
<candidate component='1'
foundation='1'
@ -289,7 +295,7 @@
</jingle>
</iq>
]]></example>
<example caption="Initiator Sends a Second Candidate"><![CDATA[
<example caption="Initiator sends a second candidate"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='info2'
to='juliet@capulet.com/balcony'
@ -298,7 +304,7 @@
action='transport-info'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
<candidate component='1'
foundation='1'
@ -316,7 +322,7 @@
</jingle>
</iq>
]]></example>
<example caption="Initiator Sends a Third Candidate"><![CDATA[
<example caption="Initiator sends a third candidate"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='info3'
to='juliet@capulet.com/balcony'
@ -325,7 +331,7 @@
action='transport-info'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
<candidate component='1'
foundation='1'
@ -344,7 +350,7 @@
</iq>
]]></example>
<p>For each candidate received, the other party MUST acknowledge receipt or return an error:</p>
<example caption="Responder Acknowledges Receipt"><![CDATA[
<example caption="Responder acknowledges receipt"><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='info1' type='result'/>
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='info2' type='result'/>
@ -355,7 +361,7 @@
</section2>
<section2 topic='Acceptance of Successful Candidate' anchor='protocol-acceptance'>
<p>If, based on STUN connectivity checks, the responder determines that it will be able to establish a connection using a given candidate, it sends a &JINGLE; element with an action of 'content-accept' (or 'session-accept') to the initiator, specifying the candidate that succeeded:</p>
<example caption="Responder Definitively Accepts the Successful Candidate"><![CDATA[
<example caption="Responder definitively accepts the successful candidate"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='accept1'
to='romeo@montague.net/orchard'
@ -365,7 +371,7 @@
initiator='romeo@montague.net/orchard'
responder='juliet@capulet.com/balcony'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<content creator='initiator' name='this-is-the-audio-content' profile='RTP/AVP'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0176.html#ns-udp'>
<candidate component='1'
foundation='1'
@ -385,7 +391,7 @@
]]></example>
<p>The &JINGLE; element in the content-accept stanza SHOULD possess a 'responder' attribute that explicitly specifies the full JID of the responding entity. If the 'responder' attribute is provided, all future commmunications SHOULD be sent to the JID provided in the 'responder' attribute.</p>
<p>If the initiator can also send data over that candidate, then it acknowledges the responder's acceptance:</p>
<example caption="Initiator Acknowledges Acceptance of Successful Candidate"><![CDATA[
<example caption="Initiator acknowledges acceptance of successful candidate"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='accept1'
to='juliet@capulet.com/balcony'
@ -393,7 +399,7 @@
]]></example>
<p>Now the initiator and responder can begin sending data over the negotiated connection.</p>
<p>If a candidate succeeded for the responder but the initiator cannot send data over that candidate, it MUST return a &notacceptable; error in response to the responder's acceptance of the successful candidate:</p>
<example caption="Initiator Returns Error in Response to Acceptance of Successful Candidate"><![CDATA[
<example caption="Initiator returns error in response to acceptance of successful candidate"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='accept1'
to='juliet@capulet.com/balcony'
@ -403,13 +409,13 @@
</error>
</iq>
]]></example>
<p>If the responder cannot find a suitable candidate transport or it receives a &notacceptable; error from the initiator in response to its acceptance of a suitable transport, it SHOULD terminate the session as described in Section 5.9 of <cite>XEP-0166</cite>.</p>
<p>If the responder cannot find a suitable candidate transport or it receives a &notacceptable; error from the initiator in response to its acceptance of a suitable transport, it SHOULD terminate the session as described in Section 6.8 of <cite>XEP-0166</cite>.</p>
</section2>
</section1>
<section1 topic='Determining Support' anchor='support'>
<p>If an entity supports the Jingle ice-udp transport, it MUST return a feature of "http://www.xmpp.org/extensions/xep-0176.html#ns-udp" &NSNOTE; in response to &xep0030; information requests.</p>
<example caption="Service Discovery information request"><![CDATA[
<example caption="Service discovery information request"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='disco1'
to='juliet@capulet.com/balcony'
@ -417,7 +423,7 @@
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<example caption="Service Discovery information response"><![CDATA[
<example caption="Service discovery information response"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='disco1'
to='romeo@montague.net/orchard'
@ -430,7 +436,7 @@
</iq>
]]></example>
<p>If an entity supports the Jingle ice-tcp transport, it MUST return a feature of "http://www.xmpp.org/extensions/xep-0176.html#ns-tcp" &NSNOTE; in response to <cite>XEP-0030</cite> information requests.</p>
<example caption="Service Discovery information request"><![CDATA[
<example caption="Service discovery information request"><![CDATA[
<iq from='romeo@montague.net/orchard'
id='disco3'
to='juliet@capulet.com/balcony'
@ -438,7 +444,7 @@
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<example caption="Service Discovery information response"><![CDATA[
<example caption="Service discovery information response"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='disco2'
to='romeo@montague.net/orchard'