MEMCACHED module
Admin Guide
Section titled “Admin Guide”Overview
Section titled “Overview”This module is an implementation of a cache system designed to work with a memcached server. It uses libmemcached client library to connect to several memcached servers that store data. It uses the Key-Value interface exported from the core.
Advantages
Section titled “Advantages”- memory costs are no longer on the server
- many servers may be used so the memory is virtually unlimited
- the cache is persistent so a restart of the server will not affect the cache
- memcached is an open-source project so it can be used to exchange data with various other applicationsr
- servers may be grouped together (e.g. for security purposes : some can be inside a private network, some can be in a public one)
Limitations
Section titled “Limitations”- keys (in key:value pairs) may not contain spaces or control characters
Dependencies
Section titled “Dependencies”OpenSIPS Modules
Section titled “OpenSIPS Modules”None.
External Libraries or Applications
Section titled “External Libraries or Applications”The following libraries or applications must be installed before running OpenSIPS with this module loaded:
- libmemcached: libmemcached can be downloaded from: http://tangent.org/552/libmemcached.html. Download the archive, extract sources, run ./configure, make, sudo make install.
...$ wget http://download.tangent.org/libmemcached-0.31.tar.gz$ tar -xzvf libmemcached-0.31.tar.gz$ cd libmemcached-0.31$ ./configure$ make$ sudo make install...Exported Parameters
Section titled “Exported Parameters”cachedb_url (string)
Section titled “cachedb_url (string)”The urls of the server groups that OpenSIPS will connect to in order to use the from script cache_store,cache_fetch, etc operations. It can be set more than one time. The prefix part of the URL will be the identifier that will be used from the script.
...modparam("cachedb_memcached", "cachedb_url","memcached:group1://localhost:9999,127.0.0.1/");modparam("cachedb_memcached", "cachedb_url","memcached:y://random_url:8888/");......cache_store("memcached:group1","key","$ru value");cache_fetch("memcached:y","key",$avp(10));cache_remove("memcached:group1","key");...exec_threshold (int)
Section titled “exec_threshold (int)”The maximum number of microseconds that a local cache query can last. Anything above the threshold will trigger a warning message to the log
Default value is “0 ( unlimited - no warnings )”.
...modparam("cachedb_memcached", "exec_threshold", 100000)...Exported Functions
Section titled “Exported Functions”The module does not export functions to be used in configuration script.
Contributors
Section titled “Contributors”By Commit Statistics
Section titled “By Commit Statistics”Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| # | Name | DevScore | Commits | Lines++ | Lines— |
|---|---|---|---|---|---|
| 1. | Vlad Paiu (@vladpaiu) | 23 | 13 | 865 | 69 |
| 2. | Stefan Darius (@dariusstefan) | 7 | 4 | 165 | 34 |
| 3. | Liviu Chircu (@liviuchircu) | 4 | 2 | 6 | 6 |
| 4. | Razvan Crainea (@razvancrainea) | 3 | 1 | 2 | 2 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | 3 | 1 | 1 | 1 |
(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)
(2) including any documentation-related commits, excluding merge commits
(3) ignoring whitespace edits, renamed files and auto-generated files
By Commit Activity
Section titled “By Commit Activity”| # | Name | Commit Activity |
|---|---|---|
| 1. | Stefan Darius (@dariusstefan) | Jun 2026 - Jul 2026 |
| 2. | Razvan Crainea (@razvancrainea) | Jun 2026 - Jun 2026 |
| 3. | Liviu Chircu (@liviuchircu) | Mar 2014 - Sep 2014 |
| 4. | Vlad Paiu (@vladpaiu) | Oct 2011 - May 2014 |
| 5. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jan 2013 - Jan 2013 |
(1) including any documentation-related commits, excluding merge commits
Documentation
Section titled “Documentation”Contributors
Section titled “Contributors”Last edited by: Razvan Crainea (@razvancrainea), Vlad Paiu (@vladpaiu), Bogdan-Andrei Iancu (@bogdan-iancu).
License
Section titled “License”All documentation files (i.e. .md extension) are licensed under the Creative Common License 4.0