[sr-dev] git:master:6aafae5d: presence: updated docs for publ_cache parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 6aafae5d2803387abe4d634c7d0e740386ca20b4
URL: https://github.com/kamailio/kamailio/commit/6aafae5d2803387abe4d634c7d0e740386ca20b4

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-04-20T17:21:08+02:00

presence: updated docs for publ_cache parameter

---

Modified: src/modules/presence/doc/presence_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/6aafae5d2803387abe4d634c7d0e740386ca20b4.diff
Patch: https://github.com/kamailio/kamailio/commit/6aafae5d2803387abe4d634c7d0e740386ca20b4.patch

---

diff --git a/src/modules/presence/doc/presence_admin.xml b/src/modules/presence/doc/presence_admin.xml
index 8f65c394e2..850e929f67 100644
--- a/src/modules/presence/doc/presence_admin.xml
+++ b/src/modules/presence/doc/presence_admin.xml
@@ -525,12 +525,20 @@ modparam("presence", "subs_db_mode", 1)
 	<section id="presence.p.publ_cache">
 		<title><varname>publ_cache</varname> (int)</title>
 		<para>
-		To improve performance, the presence module holds by default a
-		publish cache that says if a certain publication exists in database.
-		This is only a list of URI + event, so it does not use much memory.
-		The cache is used when a Subscription is received to check if there
-		is any published state in database. This way unnecessary queries in
-		presentity table are avoided.
+		To improve performance, the presence module can operate in a couple of
+		modes related to how PUBLISH data is stored. If publ_cache is 0,
+		then no information is store in memory.
+		</para>
+		<para>
+		If publ_cache is 1, then the module keeps in memory an index of the
+		records stored in database, In this mode it keeps only the list of URIs
+		and events, so it does not use much memory. The cache is used when a
+		Subscription is received to check if there is any published state in
+		database. This way unnecessary queries in presentity table are avoided.
+		</para>
+		<para>
+		If publ_cache is 2, then the module keeps everything related to PUBLISH
+		requests in memory, not storing anything in the database.
 		</para>
 		<para>
 		Setting this parameter to 0 will disable the usage of the publish