moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-12-21 23:28:51 -05:00
Code Issues Releases Wiki Activity

0.9

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1423 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-11-27 19:45:02 +00:00
parent 5faa78762c
commit 38020c4a0c
1 changed files with 45 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
xep-0177.xml
View File

@ -6,7 +6,7 @@
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
<title>Jingle Raw UDP Transport</title>
<title>Jingle Raw UDP Transport Method</title>
<abstract>This document defines a Jingle transport method that results in sending data over a raw User Datagram Protocol (UDP) connection.</abstract>
&LEGALNOTICE;
<number>0177</number>
@ -26,6 +26,12 @@
&scottlu;
&hildjj;
&seanegan;
<revision>
<version>0.9</version>
<date>2007-11-27</date>
<initials>psa</initials>
<remark><p>Further editorial review.</p></remark>
</revision>
<revision>
<version>0.8</version>
<date>2007-11-15</date>
@ -85,7 +91,7 @@
<li>Make it relatively easy to implement support in standard Jabber/XMPP clients.</li>
<li>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.</li>
</ol>
<p>Note: The Raw UDP transport does not provide traversal of Network Address Translators (NATs); if NAT traversal is needed, &xep0176; SHOULD be used. The Raw UDP transport method is defined only for the purpose of specifying the IP address and port that an entity considers "most likely to succeed" and is a "hit-or-miss" method that may work in some circumstances. The method can therefore be thought of as the Jingle equivalent of the "I'm Feeling Lucky" button; it is also helpful for use in unit-testing of Jingle implementation by developers working on a local network (see &xep0208;).</p>
<p>Note: The Raw UDP transport does not provide traversal of Network Address Translators (NATs); if NAT traversal is needed, &xep0176; SHOULD be used. The Raw UDP transport method is defined only for the purpose of specifying the IP address and port that an entity considers "most likely to succeed" and is a "hit-or-miss" method that may work in some circumstances. The method can therefore be thought of as the Jingle equivalent of the "I'm Feeling Lucky" button; it is also helpful for use in unit-testing of Jingle implementation by developers working on a local network (see &xep0208;).</p>
</section1>
<section1 topic='Jingle Conformance' anchor='conformance'>
<p>In accordance with Section 8 of <cite>XEP-0166</cite>, this document specifies the following information related to the Jingle Raw UDP transport type:</p>
@ -100,7 +106,10 @@
<section2 topic='Transport Initiation' anchor='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 content type. If the initiator 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 &NSNOTE;, which MUST <note>This is required to avoid a round trip and help expedite the negotiation.</note> include the initiator's Raw UDP candidate via the 'ip', 'port', 'generation', and 'name' attributes of the &CANDIDATE; element.</p>
<example caption="Initiation"><![CDATA[
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' id='jingle1' type='set'>
<iq from='romeo@montague.net/orchard'
id='jingle1'
to='juliet@capulet.com/balcony'
type='set'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
action='session-initiate'
initiator='romeo@montague.net/orchard'
@ -131,16 +140,19 @@
</tr>
<tr>
<td>Permissive</td>
<td>Server reflexive or peer reflexive candidate discovered via &rfc3489;</td>
<td>Server reflexive or peer reflexive candidate discovered via STUN (see &rfc3489; and &rfc3489bis;)</td>
</tr>
</table>
</section2>
<section2 topic='Responder Response' anchor='response'>
<p>As described in <cite>XEP-0166</cite>, to provisionally accept the session initiation request, the receiver returns an IQ-result:</p>
<example caption="Responder provisionally accepts the session request"><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='result' id='jingle1'/>
<p>As described in <cite>XEP-0166</cite>, to acknowledge the session initiation request, the responder returns an IQ-result:</p>
<example caption="Responder acknowledges the session-initiate request"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='jingle1'
to='romeo@montague.net/orchard'
type='result'/>
]]></example>
<p>Once the responder provisionally accepts the session, it:</p>
<p>Once the responder acknowledges the session initiation request, it:</p>
<ul>
<li>MUST attempt to send media data via UDP to the IP and port specified in the initiator's Raw UDP candidate.</li>
<li>SHOULD send its own Raw UDP candidate to the initiator via a Jingle "transport-info" message.</li>
@ -153,7 +165,10 @@
<section3 topic='Sending A Candidate' anchor='response-candidate'>
<p>As noted, the responder SHOULD send its own Raw UDP candidate to the initiator by sending a transport-info message to the initiator, as shown in the following example.</p>
<example caption="Responder sends its Raw UDP candidate"><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' id='jingle2' type='set'>
<iq from='juliet@capulet.com/balcony'
id='jingle2'
to='romeo@montague.net/orchard'
type='set'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
action='transport-info'
initiator='romeo@montague.net/orchard'
@ -168,13 +183,16 @@
]]></example>
<p>The initiator MUST then acknowledge receipt by returning an IQ result (or a standard XMPP error).</p>
<example caption="Initiator acknowledges receipt of candidate"><![CDATA[
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' type='result' id='jingle2'/>
<iq from='romeo@montague.net/orchard'
id='jingle2'
to='juliet@capulet.com/balcony'
type='result'/>
]]></example>
<p>Naturally, the initiator SHOULD also attend to send media to the responder as specified above. This media too may or may not get through, but if it does then the other party SHOULD acknowledge receipt.</p>
<p>Naturally, the initiator SHOULD also attempt to send media to the responder as specified above. This media too may or may not get through, but if it does then the other party SHOULD acknowledge receipt.</p>
</section3>
<section3 topic='Sending An Informational Message' anchor='response-info'>
<p>When it attempts to send data to a Raw UDP candidate, a party SHOULD send an informational message of &lt;trying/&gt;.</p>
<example caption="Receiver sends trying message"><![CDATA[
<example caption="Responder sends trying message"><![CDATA[
<iq from='juliet@capulet.com/balcony'
id='trying1'
to='romeo@montague.net/orchard'
@ -188,10 +206,10 @@
</iq>
]]></example>
<example caption="Initiator acknowledges trying message"><![CDATA[
<iq from='romeo@montague.lit/orchard'
<iq from='romeo@montague.lit/orchard'
id='trying1'
to='juliet@capulet.lit/balcony'
type='result'/>
to='juliet@capulet.lit/balcony'
type='result'/>
]]></example>
<p>If a party receives data, it SHOULD send an informational message of &lt;received/&gt;.</p>
<example caption="Initiator sends received message"><![CDATA[
@ -207,17 +225,17 @@
</jingle>
</iq>
]]></example>
<example caption="Receiver acknowledges received message"><![CDATA[
<iq from='juliet@capulet.lit/balcony'
<example caption="Responder acknowledges received message"><![CDATA[
<iq from='juliet@capulet.lit/balcony'
id='received1'
to='romeo@montague.lit/orchard'
type='result'/>
to='romeo@montague.lit/orchard'
type='result'/>
]]></example>
</section3>
</section2>
<section2 topic='Informational Messages' anchor='protocol-info'>
<p>Informational messages MAY be sent by the either party within the context of the Raw UDP transport to communicate whether the party has attempted to send media or has received media. The informational message MUST be an IQ-set containing a &JINGLE; element of type "session-info", where the informational message is a payload element qualified by the 'http://www.xmpp.org/extensions/xep-0177.html#ns-info' namespace &NSNOTE;. The following payload elements are defined:</p>
<p>Informational messages MAY be sent by either party within the context of the Raw UDP transport to communicate whether the party has attempted to send media or has received media. The informational message MUST be an IQ-set containing a &JINGLE; element of type "session-info", where the informational message is a payload element qualified by the 'http://www.xmpp.org/extensions/xep-0177.html#ns-info' namespace &NSNOTE;. The following payload elements are defined:</p>
<table caption='Information Payload Elements'>
<tr>
<th>Element</th>
@ -239,18 +257,18 @@
<section1 topic='Determining Support' anchor='support'>
<p>If an entity supports the Jingle Raw UDP transport, it MUST return a feature of "http://www.xmpp.org/extensions/xep-0177.html#ns" &NSNOTE; in response to &xep0030; information requests.</p>
<example caption="Service discovery information request"><![CDATA[
<iq type='get'
from='romeo@montague.net/orchard'
<iq from='romeo@montague.net/orchard'
id='disco1'
to='juliet@capulet.com/balcony'
id='disco1'>
type='get'>
<query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
<example caption="Service discovery information response"><![CDATA[
<iq type='result'
from='juliet@capulet.com/balcony'
<iq from='juliet@capulet.com/balcony'
id='disco1'
to='romeo@montague.net/orchard'
id='disco1'>
type='result'>
<query xmlns='http://jabber.org/protocol/disco#info'>
...
<feature var='http://www.xmpp.org/extensions/xep-0177.html#ns'/>
@ -258,6 +276,7 @@
</query>
</iq>
]]></example>
<p>Naturally, support MAY also be determined via the dynamic, presence-based profile of Service Discovery defined in &xep0115;.</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>