1.3pre1: Sequence header

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@2149 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2008-08-11 20:45:59 +00:00
parent 66fe5d18f9
commit c8690fa35f
1 changed files with 58 additions and 0 deletions

View File

@ -26,6 +26,12 @@
<registry/>
&stpeter;
&hildjj;
<revision>
<version>1.3pre1</version>
<date>in progress, last updated 2008-08-11</date>
<initials>psa</initials>
<remark><p>Added Sequence header.</p></remark>
</revision>
<revision>
<version>1.2</version>
<date>2006-07-12</date>
@ -188,6 +194,58 @@
<section2 topic='Distribute' anchor='headers-distribute'>
<p>The Distribute header enables a sender to specify whether the stanza may be further distributed by the recipient to other entities on the network. The allowable values for this header are "true" and "false". If the sender specifies a value of "false", the recipient MUST NOT further distribute the stanza or any information contained therein; if the sender specifies a value of "true", the recipient MAY further distribute the stanza or any information contained therein; if the value is anything other than "true" or "false" and the recipient does not understand the value, the recipient MUST assume the default value of "false". This header is semantically equivalent to the "Distribute" flag defined in &geoprivpol;. (The HTTP "Max-Forwards" header is not appropriate for this usage, since it defines proxy and gateway behavior rather than recipient behavior.) Note: This header may be security-sensitive (see the <link url='#security'>Security Considerations</link> for details).</p>
</section2>
<section2 topic='Sequence' anchor='headers-sequence'>
<p>The Sequence header enables a sender to assign a sequence number to a message. This is most useful for notifications, web services interactions, and other automated processes.</p>
<example caption='A Sequence of Notifications'><![CDATA[
<message from='user@pubsub.tld'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='trip-meter'>
<item id='foo'>
<geoloc xmlns='http://jabber.org/protocol/geoloc'>
<lat>39.755109</lat>
<lon>-104.997497</lon>
</geoloc>
</item>
</items>
</event>
<headers xmlns='http://jabber.org/protocol/shim'>
<header name='Sequence'>0</header>
</headers>
</message>
<message from='user@pubsub.tld'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='trip-meter'>
<item id='bar'>
<geoloc xmlns='http://jabber.org/protocol/geoloc'>
<lat>39.752799</lat>
<lon>-104.998871</lon>
</geoloc>
</item>
</items>
</event>
<headers xmlns='http://jabber.org/protocol/shim'>
<header name='Sequence'>1</header>
</headers>
</message>
<message from='user@pubsub.tld'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='trip-meter'>
<item id='baz'>
<geoloc xmlns='http://jabber.org/protocol/geoloc'>
<lat>39.751958</lat>
<lon>-105.00045</lon>
</geoloc>
</item>
</items>
</event>
<headers xmlns='http://jabber.org/protocol/shim'>
<header name='Sequence'>2</header>
</headers>
</message>
]]></example>
</section2>
<section2 topic='Store' anchor='headers-store'>
<p>The Store header enables a sender to specify whether the stanza may be stored or archived by the recipient. The allowable values for this header are "true" and "false". If the sender specifies a value of "false", the recipient MUST NOT store the stanza or any information contained therein; if the sender specifies a value of "true", the recipient MAY store the stanza or any information contained therein; if the value is anything other than "true" or "false" and the recipient does not understand the value, the recipient MUST assume the default value of "false". Note: This header may be security-sensitive (see the <link url='#security'>Security Considerations</link> for details).</p>
</section2>