view mod_presence_cache/README.markdown @ 1959:65beed3ac500

mod_presence_cache/README: Try to discourage full stanza caching since it is experimental
author Kim Alvefur <>
date Thu, 10 Dec 2015 17:13:12 +0100
parents 9d0c33ebbcc5
children 39d958f4a0c3
line wrap: on
line source

summary: Cache presence incoming presence


This module stores presence from users contact even when they are
offline, so that the client can see who is online faster when they sign
in, and won't have to wait for remote servers to reply.

Note that in its current form, the number of presence stanzas sent to a
client is doubled, as the client would get both the cached stanzas and
replies to presence probes. Also see [mod\_throttle\_presence].

By default, only binary (online or offline) state is stored. It can
optionally store the full presence but this requires much more memory
and bandwidth.


Just enable the module.

    modules_enabled = {
        -- more modules

Advanced configuration

To enable *experimental* full stanza caching:

    presence_cache_full = false

This will usually double the presence data sent to clients, pending
support for deduplication.


-   Deduplication, i.e don's send stanzas that are identical to the last
-   Cache invalidation or expiry, eg if a remote server goes down or is
    gone a long time.
-   Sending probes at some interval to keep the cache reasonably fresh.