moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-21 16:55:07 -05:00
Code Issues Releases Wiki Activity

0.7

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1008 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-06-26 02:33:50 +00:00
parent 447a8dbff3
commit b7e2c3a898
1 changed files with 46 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
xep-0177.xml
View File

@ -26,6 +26,12 @@
&scottlu;
&hildjj;
&seanegan;
<revision>
<version>0.7</version>
<date>2007-06-25</date>
<initials>psa</initials>
<remark><p>More clearly specified the hit-or-miss nature of the transport; corrected informational messages.</p></remark>
</revision>
<revision>
<version>0.6</version>
<date>2007-04-17</date>
@ -73,7 +79,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) 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. <note>This is also helpful for bootstrapping of Jingle implementation by developers working on a local network.</note> If NAT traversal is needed, &xep0176; SHOULD be used.</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>
@ -130,34 +136,16 @@
]]></example>
<p>Once the responder provisionally accepts the session, it:</p>
<ul>
<li>MUST check the initiator's Raw UDP candidate by attempting to send data via UDP to the specified IP and port (see next section).</li>
<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>
<li>MAY send an informational message.</li>
<li>SHOULD send an informational message of &lt;trying/&gt;.</li>
</ul>
<p>These are done simultaneously in order to ensure that a connection can be made, since the initiator's Raw UDP candidate may not result in success.</p>
<section3 topic='Checking the Initiator&apos;s Candidate' anchor='response-check'>
<p>The responder MUST immediately attempt to send data to the IP and port specified in the initiation request. Because delivery of UDP data is not acknowledged, the data SHOULD be sent using the echo protocol (&rfc0862;) over the IP address and port specified in the Raw UDP candidate; if the data is echoed back, the recipient would then send a Jingle "content-accept" (or "session-accept") action to the initiator.</p>
<example caption="Responder Returns Transport-Accept"><![CDATA[
<iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='set' id='accept1'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
action='content-accept'
initiator='romeo@montague.net/orchard'
sid='a73sjjvkla37jfea'>
<content creator='initiator' name='this-is-the-audio-content'>
<transport xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns'>
<candidate name='myvoicedata' ip='10.1.1.104' port='13540' generation='0'/>
</transport>
</content>
</jingle>
</iq>
]]></example>
<p>The initiator MUST then acknowledge acceptance by returning an IQ result (or a standard XMPP error).</p>
<example caption="Initiator Acknowledges Transport Accept"><![CDATA[
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' type='result' id='accept1'/>
]]></example>
<section3 topic='Sending Media' anchor='response-send'>
<p>The responder MUST immediately attempt to send data to the IP and port specified in the initiation request. If all goes well, the data will be received by the initiator and media will flow. Because delivery of UDP data is not acknowledged, a party that receives media SHOULD send an informational message of &lt;received/&gt; to the other party as specified below.</p>
</section3>
<section3 topic='Sending A Candidate' anchor='response-candidate'>
<p>While checking the initiator's Raw UDP candidate, 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>
<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'>
<jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
@ -176,31 +164,28 @@
<example caption="Initiator Acknowledges Receipt of Candidate"><![CDATA[
<iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' type='result' id='jingle2'/>
]]></example>
<p>Naturally, the initiator then MUST also check the responder's Raw UDP candidate by following the checking procedure outlined above.</p>
<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>
</section3>
<section3 topic='Sending An Informational Message' anchor='response-info'>
<p>While checking the initiator's Raw UDP candidate, the responder 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 "session-info", where the informational message is a payload element specified in the <link url='#info'>Informational Messages</link> section of this document.</p>
<p>When it attempts to send data to a Raw UDP candidate, a party SHOULD send an informational message of &lt;trying/&gt;. If a party receives data, it SHOULD send an informational message of &lt;received/&gt;.</p>
<p>Each informational message MUST be an IQ-set containing a &JINGLE; element of type "session-info", where the informational message is a payload element specified in the <link url='#info'>Informational Messages</link> section of this document.</p>
</section3>
</section2>
<section2 topic='Informational Messages' anchor='protocol-info'>
<p>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 "session-info", where the informational message is a payload element qualified by the 'http://www.xmpp.org/extensions/xep-0177.html#ns-info' namespace (see <link url='#ns'>Protocol Namespaces</link>). The following payload elements are defined:</p>
<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>
<table caption='Information Payload Elements'>
<tr>
<th>Element</th>
<th>Meaning</th>
</tr>
<tr>
<td>&lt;failed/&gt;</td>
<td>Connectivity checks failed.</td>
</tr>
<tr>
<td>&lt;succeeded/&gt;</td>
<td>Connectivity checks succeeded.</td>
<td>&lt;received/&gt;</td>
<td>The party has received media.</td>
</tr>
<tr>
<td>&lt;trying/&gt;</td>
<td>Connectivity checks are underway.</td>
<td>The party is trying to send media.</td>
</tr>
</table>
<p>Note: Because the informational message is sent in an IQ-set, the receiving party MUST return either an IQ-result or an IQ-error (normally only an IQ-result to acknowledge receipt; no error flows are defined or envisioned at this time).</p>
@ -256,7 +241,8 @@
</section2>
</section1>
<section1 topic='XML Schema' anchor='schema'>
<code><![CDATA[
<section2 topic='Transport' anchor='schema-transport'>
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
@ -292,6 +278,30 @@
</xs:simpleType>
</xs:schema>
]]></code>
]]></code>
</section2>
<section2 topic='Informational Messages' anchor='schema-info'>
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='http://www.xmpp.org/extensions/xep-0177.html#ns-info'
xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns-info'
elementFormDefault='qualified'>
<xs:element name='received' type='empty'/>
<xs:element name='trying' type='empty'/>
<xs:simpleType name='empty'>
<xs:restriction base='xs:string'>
<xs:enumeration value=''/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
]]></code>
</section2>
</section1>
</xep>