Software / code / prosody-modules
Comparison
mod_presence_cache/README.markdown @ 1952:9d0c33ebbcc5
mod_presence_cache: Cache incoming presence broadcasts in order to get clients up to speed with who is online faster
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Mon, 16 Nov 2015 18:19:25 +0100 |
| child | 1959:65beed3ac500 |
comparison
equal
deleted
inserted
replaced
| 1951:7974a24d29b6 | 1952:9d0c33ebbcc5 |
|---|---|
| 1 --- | |
| 2 summary: Cache presence incoming presence | |
| 3 ... | |
| 4 | |
| 5 Introduction | |
| 6 ============ | |
| 7 | |
| 8 This module stores presence from users contact even when they are | |
| 9 offline, so that the client can see who is online faster when they sign | |
| 10 in, and won't have to wait for remote servers to reply. | |
| 11 | |
| 12 Note that in its current form, the number of presence stanzas sent to a | |
| 13 client is doubled, as the client would get both the cached stanzas and | |
| 14 replies to presence probes. Also see [mod\_throttle\_presence]. | |
| 15 | |
| 16 By default, only binary (online or offline) state is stored. It can | |
| 17 optionally store the full presence but this requires much more memory. | |
| 18 | |
| 19 Configuration | |
| 20 ============= | |
| 21 | |
| 22 Just enable the module. | |
| 23 | |
| 24 modules_enabled = { | |
| 25 -- more modules | |
| 26 "presence_cache"; | |
| 27 } | |
| 28 | |
| 29 Advanced configuration | |
| 30 ====================== | |
| 31 | |
| 32 To enable full stanza caching: | |
| 33 | |
| 34 presence_cache_full = false | |
| 35 | |
| 36 TODO | |
| 37 ==== | |
| 38 | |
| 39 - Deduplication, i.e don's send stanzas that are identical to the last | |
| 40 seen. | |
| 41 - Cache invalidation or expiry, eg if a remote server goes down or is | |
| 42 gone a long time. | |
| 43 - Sending probes at some interval to keep the cache reasonably fresh. | |
| 44 | |
| 45 |