This commit is contained in:
Peter Saint-Andre 2013-11-19 14:03:08 -07:00
parent 388e7e9fe0
commit c1d2f0ee51
1 changed files with 15 additions and 56 deletions

View File

@ -31,11 +31,13 @@
<jid>j.lagrange@jabber.org</jid>
<jid>j.lagrange@gajim.org</jid>
</author>
<author>
<firstname>Lance</firstname>
<surname>Stout</surname>
<email>lancestout@gmail.com</email>
</author>
&lance;
<revision>
<version>0.2</version>
<date>2013-11-19</date>
<initials>jl</initials>
<remark><p>Corrected namespace to use XSF format.</p></remark>
</revision>
<revision>
<version>0.1</version>
<date>2013-06-11</date>
@ -75,7 +77,7 @@
from='juliet@capulet.com/chamber'
to='romeo@montague.net/home'
id='1234'>
<query xmlns="urn:xmpp:fis" />
<query xmlns="urn:xmpp:fis:0" />
</iq>
]]>
</example>
@ -86,7 +88,7 @@
from='romeo@montague.net/home'
to='juliet@capulet.com/chamber'
id='1234'>
<query xmlns="urn:xmpp:fis">
<query xmlns="urn:xmpp:fis:0">
<directory name='documents'/>
<directory name='pics'/>
<directory name='audio'/>
@ -101,7 +103,7 @@
from='romeo@montague.net/home'
to='juliet@capulet.com/chamber'
id='1234'>
<query xmlns="urn:xmpp:fis" />
<query xmlns="urn:xmpp:fis:0" />
</iq>
]]>
</example>
@ -112,11 +114,11 @@
from='juliet@capulet.com/chamber'
to='romeo@montague.net/home'
id='1234'>
<query xmlns="urn:xmpp:fis" node="documents" />
<query xmlns="urn:xmpp:fis:0" node="documents" />
</iq>
]]>
</example>
<p>When replying with a list of files, the offering entity can choose to either reply with verbose information on the file using the file attributes defined by &xep0254; or it may reply only with the 'name' attribute, which is required and MUST be included in every response.</p>
<p>When replying with a list of files, the offering entity can choose to either reply with verbose information on the file using the file attributes defined by &xep0234; or it may reply only with the 'name' attribute, which is required and MUST be included in every response.</p>
<p>It is RECOMENDED, when the list files to be sent is small, that a verbose response be made (in order to avoid going back and forth requesting information), and that a non-verbose reponse be made otherwise. This recomendation is made to save bandwidth.</p>
<example caption='The offering entity replies with information about a particular directory'>
<![CDATA[
@ -124,7 +126,7 @@
from='romeo@montague.net/home'
to='juliet@capulet.com/chamber'
id='1234'>
<query xmlns="urn:xmpp:fis" node="documents">
<query xmlns="urn:xmpp:fis:0" node="documents">
<file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
<name>test.txt</name>
<date>1969-07-21T02:56:15Z</date>
@ -148,7 +150,7 @@
from='juliet@capulet.com/chamber'
to='romeo@montague.net/home'
id='1234'>
<query xmlns="urn:xmpp:fis" node="documents/test2.txt" />
<query xmlns="urn:xmpp:fis:0" node="documents/test2.txt" />
</iq>
]]>
</example>
@ -158,7 +160,7 @@
from='romeo@montague.net/home'
to='juliet@capulet.com/chamber'
id='1234'>
<query xmlns="urn:xmpp:fis" node="test2.txt">
<query xmlns="urn:xmpp:fis:0" node="test2.txt">
<file xmlns='urn:xmpp:jingle:apps:file-transfer:3'>
<name>test2.txt</name>
<size>1000</size>
@ -179,49 +181,6 @@
<section2 topic='Out of Band Transfer' anchor='out-of-band'>
<p>One obvious way to overcome the limitations of sending large stanzas in-band, is to transfer that information out of band. &xep0265; could be used for that purpose. It is hereby RECOMMENDED its implementation when the offering entity has a massive amount of files that would not be practical to advertise in-band.</p>
<p>It is further recommended that when using XEP-0265, the entire directory structure, along with all the files in the shared folder and subfolders, be exchanged in one single reply. Also, all the files attributes should be included. This is to avoid wasting bandwidth initiating out of band streams going back and forth. </p>
<!--
<p>One obvious way to overcome the limitations of sending large stanzas in-band, is to transfer that information out of band. Several extensions have tackled that problem, for example &xep0265; and &xep0105; could be used for this purpose. Unfortunately, both of those extensions are deprecated and thus it is not advised their implementation.</p>
<p>A workaround which would provide the same functionality as those xeps, is to advertise the existence of a tree.xml file in the root of the shared folder. This file would contain the whole directory structure of the shared folder. Its format is exactly the same as the stanzas defined herein, with the exception that it MUST NOT include the "iq" portion of the stanza.</p>
<p>It is strongly RECOMMENDED that tree.xml include relevant information of the files in order to avoid wasting bandwidth</p>
<example caption='The format of tree.xml'>
<![CDATA[
<match>
<offer>
<file>
<date>1969-07-21T02:56:15Z</date>
<desc>This is a test. If this were a real file...</desc>
<name>test.txt</name>
<size>1022</size>
<hash xmlns='urn:xmpp:hashes:1' algo='sha-1'>552da749930852c69ae5d2141d3766b1</hash>
</file>
<file>
<name>test2.txt</name>
<date>1970-07-21T02:56:15Z</date>
<desc/>
<size>1000</size>
<hash xmlns='urn:xmpp:hashes:1' algo='sha-1'>662da749930852c69ae5d2141d3766b1</hash>
</file>
<directory name='/pics'>
<file>
<name>test3.png</name>
<date>1980-07-21T02:56:15Z</date>
<desc/>
<size>10340</size>
<hash xmlns='urn:xmpp:hashes:1' algo='sha-1'>662da749930852c69ae5d2141d3776b1</hash>
</file>
<file>
<name>test4.png</name>
<date>1990-07-21T02:56:15Z</date>
<desc/>
<size>10740</size>
<hash xmlns='urn:xmpp:hashes:1' algo='sha-1'>662da749930852c69ae5d2141d3776b2</hash>
</file>
</directory>
</offer>
</match>
]]>
</example>
-->
</section2>
</section1>
<section1 topic='Implementation Notes' anchor='implementation'>