[sr-dev] git:master: memcached: document new memory parameter for memory manager setting

Henning Westerholt hw at kamailio.org
Sun Jun 30 16:06:33 CEST 2013


Module: sip-router
Branch: master
Commit: b252d4ec79446bd915fe2eb6bcf8556d3275343c
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b252d4ec79446bd915fe2eb6bcf8556d3275343c

Author: Henning Westerholt <hw at kamailio.org>
Committer: Henning Westerholt <hw at kamailio.org>
Date:   Sun Jun 30 16:06:16 2013 +0200

memcached: document new memory parameter for memory manager setting

---

 modules/memcached/README                  |   21 +++++++++++++++++++++
 modules/memcached/doc/memcached_admin.xml |   26 ++++++++++++++++++++++++++
 2 files changed, 47 insertions(+), 0 deletions(-)

diff --git a/modules/memcached/README b/modules/memcached/README
index 1aeb1f9..730fa4d 100644
--- a/modules/memcached/README
+++ b/modules/memcached/README
@@ -27,6 +27,7 @@ Henning Westerholt
               4.2. expire (integer)
               4.3. mode (integer)
               4.4. timeout (integer)
+              4.5. memory (integer)
 
         5.
 
@@ -42,6 +43,7 @@ Henning Westerholt
    1.6. Set expire parameter
    1.7. Set mode parameter
    1.8. Set timeout parameter
+   1.9. Set memory parameter
 
 Chapter 1. Admin Guide
 
@@ -64,6 +66,7 @@ Chapter 1. Admin Guide
         4.2. expire (integer)
         4.3. mode (integer)
         4.4. timeout (integer)
+        4.5. memory (integer)
 
    5.
 
@@ -176,6 +179,7 @@ xlog("stored value is $mct(test)"); # will return <null>
    4.2. expire (integer)
    4.3. mode (integer)
    4.4. timeout (integer)
+   4.5. memory (integer)
 
 4.1. servers (str)
 
@@ -238,6 +242,23 @@ modparam("memcached", "mode", 0)
 modparam("memcached", "timeout", 10000)
 ...
 
+4.5. memory (integer)
+
+   The memory mode for the memcached client library. The library can use
+   the system memory manager or the internal memory manager from Kamailio.
+   The system memory manager configuration is the default, most
+   implementations (like other projects) probably use this approach as
+   well. The internal memory configuration should be faster and protects
+   better against memory leaks that could bring down your server, as the
+   available memory pool is limited by the Kamailio configuration.
+
+   Default value is “0” (use system memory manager).
+
+   Example 1.9. Set memory parameter
+...
+modparam("memcached", "memory", 1)
+...
+
    5.1. Exported pseudo-variables
 
 5.1. Exported pseudo-variables
diff --git a/modules/memcached/doc/memcached_admin.xml b/modules/memcached/doc/memcached_admin.xml
index 87dd8bb..29f17e9 100644
--- a/modules/memcached/doc/memcached_admin.xml
+++ b/modules/memcached/doc/memcached_admin.xml
@@ -241,6 +241,32 @@ modparam("memcached", "timeout", 10000)
 			</programlisting>
 		</example>
 	</section>
+	<section>
+		<title><varname>memory</varname> (integer)</title>
+		<para>
+			The memory mode for the memcached client library. The library can
+			use the system memory manager or the internal memory manager from
+			&kamailio;. The system memory manager configuration is the default,
+			most implementations (like other projects) probably use this
+			approach as well. The internal memory configuration should be
+			faster and protects better against memory leaks that could bring
+			down your server, as the available memory pool is limited by the
+			&kamailio; configuration.
+		</para>
+		<para>
+			<emphasis>
+				Default value is <quote>0</quote> (use system memory manager).
+			</emphasis>
+		</para>
+		<example>
+			<title>Set <varname>memory</varname> parameter</title>
+			<programlisting format="linespecific">
+...
+modparam("memcached", "memory", 1)
+...
+			</programlisting>
+		</example>
+	</section>
 	</section>
 	<section>
 		<section>




More information about the sr-dev mailing list