Changeset 173:6b0eb01b5744 for doc


Ignore:
Timestamp:
May 9, 2012, 2:24:28 PM (8 years ago)
Author:
Ralph Meijer <ralphm@…>
Branch:
default
Message:

Add support for roster versioning.

Location:
doc
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • doc/xmppim.rst

    r172 r173  
    3232   :language: python
    3333   :linenos:
     34
     35Roster versioning
     36^^^^^^^^^^^^^^^^^
     37
     38Some XMPP servers support roster versioning. A client can keep a cache of the
     39roster by requesting it and applying changes as roster pushes come in. Each
     40version of the roster is marked with a version identifier. This can be used
     41to request the roster upon reconnect. The server can then choose to send the
     42difference between the requested and current version as roster pushed,
     43instead of returning the complete roster.
     44
     45When no roster was cached by the client, yet, a client passes the empty
     46string (``''``) to ``getRoster`` to bootstrap the process.
     47
     48This example will force a reconnect 15 seconds after authentication.
     49
     50.. literalinclude:: listings/xmppim/roster_client_versioning.py
     51   :language: python
     52   :linenos:
Note: See TracChangeset for help on using the changeset viewer.