0.8

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1386 4b5297f7-1745-476d-ba37-a9c6900126ab

xep-0177.xml

@@ -26,6 +26,12 @@
   &scottlu;
   &hildjj;
   &seanegan;
+  <revision>
+    <version>0.8</version>
+    <date>2007-11-15</date>
+    <initials>psa</initials>
+    <remark><p>Editorial review and consistency check.</p></remark>
+  </revision>
   <revision>
     <version>0.7</version>
     <date>2007-06-25</date>
@@ -70,7 +76,7 @@
   </revision>
 </header>
 <section1 topic='Introduction' anchor='intro'>
-  <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 a transport method for establishing and managing data between XMPP entities using a raw User Datagram Protocol (UDP) connection (see &rfc0768;). This "raw-udp" method results in a lossy transport method suitable for use in media applications where some packet loss is tolerable (e.g., audio and video).</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 a transport method for establishing and managing data between XMPP entities using a raw User Datagram Protocol (UDP) connection (see &rfc0768;). This "raw-udp" method results in a lossy transport method suitable for use in media applications where some packet loss is tolerable (e.g., audio and video).</p>
 </section1>
 <section1 topic='Requirements' anchor='reqs'>
   <p>The Jingle transport method defined herein is designed to meet the following requirements:</p>
@@ -85,15 +91,15 @@
    <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>
    <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='#initiate'>Transport Initiation</link> section of this document.</p></li>
+     <li><p>The semantics of the &TRANSPORT; element are defined in the <link url='#initiate'>Transport Initiation</link> section of this document.</p></li>
      <li><p>Successful negotiation of the Raw 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.</p></li>
      <li><p>If multiple components are to be communicated over the transport, the first component shall be associated with the port in the transport initiation stanza and the second component (e.g., for RTCP) shall be associated with a UDP port that is one number higher than the specified port (e.g., if the specified port is 13540 then the port for the second component shall be 13541).</p></li>
    </ol>
 </section1>
 <section1 topic='Protocol Description' anchor='protocol'>
   <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 (see <link url='#ns'>Protocol Namespaces</link>), 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>
+    <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 Example"><![CDATA[
+    <example caption="Initiation"><![CDATA[
 <iq from='romeo@montague.net/orchard' to='juliet@capulet.com/balcony' id='jingle1' type='set'>
   <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
           action='session-initiate'
@@ -131,7 +137,7 @@
   </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[
+    <example caption="Responder provisionally accepts the session request"><![CDATA[
 <iq from='juliet@capulet.com/balcony' to='romeo@montague.net/orchard' type='result' id='jingle1'/>
     ]]></example>
     <p>Once the responder provisionally accepts the session, it:</p>
@@ -146,7 +152,7 @@
     </section3>
     <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[
+      <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'
           action='transport-info'
@@ -161,14 +167,52 @@
 </iq>
       ]]></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[
+      <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 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 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>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>When it attempts to send data to a Raw UDP candidate, a party SHOULD send an informational message of &lt;trying/&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>
+      <example caption="Receiver sends trying message"><![CDATA[
+<iq from='juliet@capulet.com/balcony'
+    id='trying1'
+    to='romeo@montague.net/orchard'
+    type='set'>
+  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
+          action='session-info'
+          initiator='romeo@montague.net/orchard'
+          sid='a73sjjvkla37jfea'>
+    <trying xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns-info'/>
+  </jingle>
+</iq>
+      ]]></example>
+      <example caption="Initiator acknowledges trying message"><![CDATA[
+<iq from='romeo@montague.lit/orchard' 
+    id='trying1'
+    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[
+<iq from='romeo@montague.net/orchard'
+    id='received1'
+    to='juliet@capulet.com/balcony'
+    type='set'>
+  <jingle xmlns='http://www.xmpp.org/extensions/xep-0166.html#ns'
+          action='session-info'
+          initiator='romeo@montague.net/orchard'
+          sid='a73sjjvkla37jfea'>
+    <received xmlns='http://www.xmpp.org/extensions/xep-0177.html#ns-info'/>
+  </jingle>
+</iq>
+      ]]></example>
+      <example caption="Receiver acknowledges received message"><![CDATA[
+<iq from='juliet@capulet.lit/balcony' 
+    id='received1'
+    to='romeo@montague.lit/orchard' 
+    type='result'/> 
+      ]]></example>
     </section3>
   </section2>
 
@@ -194,7 +238,7 @@
 
 <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[
+  <example caption="Service discovery information request"><![CDATA[
 <iq type='get'
     from='romeo@montague.net/orchard'
     to='juliet@capulet.com/balcony'
@@ -202,7 +246,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 type='result'
     from='juliet@capulet.com/balcony'
     to='romeo@montague.net/orchard'