Diff

mod_presence_cache/README.markdown @ 2147:ed2bb50d4f91

mod_presence_cache: Switch to using util.cache for limiting size of cache
author Kim Alvefur <zash@zash.se>
date Fri, 01 Apr 2016 15:18:56 +0200
parent 2146:39d958f4a0c3
line wrap: on
line diff
--- a/mod_presence_cache/README.markdown	Fri Apr 01 15:15:56 2016 +0200
+++ b/mod_presence_cache/README.markdown	Fri Apr 01 15:18:56 2016 +0200
@@ -1,17 +1,13 @@
 ---
-summary: Cache presence incoming presence
+summary: Cache presence from remote users
 ...
 
 Introduction
 ============
 
-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].
+This module stores a timestamp of the latest presence received from
+users contacts 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.
 
 Configuration
 =============
@@ -26,16 +22,11 @@
 Advanced configuration
 ======================
 
-
-
+The size of the cache is tuneable:
 
-TODO
-====
+    presence_cache_size = 99
 
--   Deduplication, i.e don's send stanzas that are identical to the last
-    seen.
--   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.
+Compatibility
+=============
 
-
+Requires 0.10 or later