summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2007-09-27 13:52:08 +0000
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2007-09-27 13:52:08 +0000
commit0b9e2fe2f2b6e66f80ae6c255be191bcf2379aab (patch)
tree60f13f32ff8db88f2a8b52bad7d7f147219a15f0 /docs
parent0d995a746085d8268d326f7eb975bf1186178014 (diff)
tubes.xml: Use a <message>-based protocol to offer and un-offer 1-1 stream tubes, instead of having the weird default bytestream
Diffstat (limited to 'docs')
-rw-r--r--docs/tubes.xml67
1 files changed, 24 insertions, 43 deletions
diff --git a/docs/tubes.xml b/docs/tubes.xml
index 470411683..3e2006fdb 100644
--- a/docs/tubes.xml
+++ b/docs/tubes.xml
@@ -352,52 +352,21 @@
'path': '/poetry/for-juliet/' # string
}
-->
- <iq to='juliet@capulet.lit/Balcony'
- from='romeo@montague.lit/Home' type='set'>
- <si xmlns='http://jabber.org/protocol/si' id='http-stream-1'
- profile='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
- <tube xmlns='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
- type='stream' initiator='romeo@montague.lit'
- service='http'
- id='http-tube-1'>
- <parameters>
- <parameter name='path' type='str'>/poetry/for-juliet/</parameter>
- </parameters>
- </tube>
- <feature xmlns='http://jabber.org/protocol/feature-neg'>
- <x xmlns="jabber:x:data" type="form">
- <field var='stream-method' type='list-single'>
- <option>
- <value>http://jabber.org/protocol/ibb</value>
- </option>
- </field>
- </x>
- </feature>
- </si>
- </presence>
+ <message to='juliet@capulet.lit/Balcony'
+ from='romeo@montague.lit/Home'>
+ <tube xmlns='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
+ type='stream' initiator='romeo@montague.lit'
+ service='http'
+ id='1402'>
+ <parameters>
+ <parameter name='path' type='str'>/poetry/for-juliet/</parameter>
+ </parameters>
+ </tube>
+ </message>
]]>
</example>
<example caption='Accepting (joining) a stream tube'>
<![CDATA[
- <!-- Juliet accepts the tube by accepting the SI -->
- <iq to='romeo@montague.lit/Home'
- from='juliet@capulet.lit/Balcony' type='result'>
- <si xmlns='http://jabber.org/protocol/si'>
- <feature xmlns='http://jabber.org/protocol/feature-neg'>
- <x xmlns='jabber:x:data' type='submit'>
- <field var='stream=method'>
- <value>http://jabber.org/protocol/ibb</value>
- </field>
- </x>
- </feature>
- </si>
- </iq>
-
- <!-- No data travels over this SI stream. FIXME: this is weird. -->
- ]]>
- </example>
- <example caption='Starting to transfer data over a stream tube'>
- <![CDATA[
<!-- Juliet's web browser connects to Juliet's XMPP implementation,
causing a stream to be opened -->
<iq to='romeo@montague.lit/Home'
@@ -405,7 +374,7 @@
<si xmlns='http://jabber.org/protocol/si' id='http-stream-1a'
profile='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
<stream xmlns='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
- tube='http-tube-1'>
+ tube='1402'>
<feature xmlns='http://jabber.org/protocol/feature-neg'>
<x xmlns="jabber:x:data" type="form">
<field var='stream-method' type='list-single'>
@@ -441,6 +410,18 @@
SI streams as shown above, and Romeo's XMPP implementation will open
multiple parallel connections to his web server. This MUST be
supported by implementations.</p>
+ <example caption='Leaving a tube'>
+ <![CDATA[
+ <!-- Romeo stops offering the stream tube.
+ He SHOULD close the stream first, if possible - assume this has
+ already been done. -->
+ <message to='juliet@capulet.lit/Balcony'
+ from='romeo@montague.lit/Home'>
+ <close xmlns='http://telepathy.freedesktop.org/xmpp/protocol/tubes'>
+ tube='1402'/>
+ </message>
+ ]]>
+ </example>
</section2>
</section1>
<section1 topic='Business Rules' anchor='rules'>