cachedb_memcached Module
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Advantages
        1.3. Limitations
        1.4. Dependencies

              1.4.1. OpenSIPS Modules
              1.4.2. External Libraries or Applications

        1.5. Exported Parameters

              1.5.1. cachedb_url (string)
              1.5.2. exec_threshold (int)
              1.5.3. Exported Functions

   2. Contributors

        2.1. By Commit Statistics
        2.2. By Commit Activity

   3. Documentation

        3.1. Contributors

   List of Tables

   2.1. Top contributors by DevScore^(1), authored commits^(2) and
          lines added/removed^(3)

   2.2. Most recently active contributors^(1) to this module

   List of Examples

   1.1. Set cachedb_url parameter
   1.2. Use memcached servers
   1.3. Set exec_threshold parameter

Chapter 1. Admin Guide

1.1. 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.

1.2. 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 applications
     * servers may be grouped together (e.g. for security purposes
       : some can be inside a private network, some can be in a
       public one)

1.3. Limitations

     * keys (in key:value pairs) may not contain spaces or control
       characters

1.4. Dependencies

1.4.1. OpenSIPS Modules

   None.

1.4.2. 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
       ...

1.5. Exported Parameters

1.5.1. 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.

   Example 1.1. Set cachedb_url parameter
...
modparam("cachedb_memcached", "cachedb_url","memcached:group1://localhos
t:9999,127.0.0.1/");
modparam("cachedb_memcached", "cachedb_url","memcached:y://random_url:88
88/");
...

   Example 1.2. Use memcached servers
...
cache_store("memcached:group1","key","$ru value");
cache_fetch("memcached:y","key",$avp(10));
cache_remove("memcached:group1","key");
...

1.5.2. 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 )”.

   Example 1.3. Set exec_threshold parameter
...
modparam("cachedb_memcached", "exec_threshold", 100000)
...

1.5.3. Exported Functions

   The module does not export functions to be used in
   configuration script.

Chapter 2. Contributors

2.1. By Commit Statistics

   Table 2.1. Top contributors by DevScore^(1), authored
   commits^(2) and lines added/removed^(3)
     Name DevScore Commits Lines ++ Lines --
   1. Vlad Paiu (@vladpaiu) 23 13 859 63
   2. Razvan Crainea (@razvancrainea) 12 10 28 16
   3. Liviu Chircu (@liviuchircu) 12 9 71 91
   4. Bogdan-Andrei Iancu (@bogdan-iancu) 7 5 5 7
   5. Maksym Sobolyev (@sobomax) 4 2 3 3
   6. Julián Moreno Patiño 3 1 1 1
   7. Peter Lemenkov (@lemenkov) 3 1 1 1
   8. Vlad Patrascu (@rvlad-patrascu) 2 1 1 0

   (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. Regarding imported patches/code, we do our best
   to count the work on behalf of the proper owner, as per the
   "fix_authors" and "mod_renames" arrays in
   opensips/doc/build-contrib.sh. If you identify any
   patches/commits which do not get properly attributed to you,
   please submit a pull request which extends "fix_authors" and/or
   "mod_renames".

   (3) ignoring whitespace edits, renamed files and auto-generated
   files

2.2. By Commit Activity

   Table 2.2. Most recently active contributors^(1) to this module
                     Name                   Commit Activity
   1. Maksym Sobolyev (@sobomax)          Feb 2023 - Feb 2023
   2. Bogdan-Andrei Iancu (@bogdan-iancu) Jan 2013 - Mar 2020
   3. Razvan Crainea (@razvancrainea)     Aug 2015 - Sep 2019
   4. Liviu Chircu (@liviuchircu)         Mar 2014 - Apr 2019
   5. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
   6. Vlad Patrascu (@rvlad-patrascu)     May 2017 - May 2017
   7. Julián Moreno Patiño                Feb 2016 - Feb 2016
   8. Vlad Paiu (@vladpaiu)               Oct 2011 - May 2014

   (1) including any documentation-related commits, excluding
   merge commits

Chapter 3. Documentation

3.1. Contributors

   Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
   (@liviuchircu), Julián Moreno Patiño, Vlad Paiu (@vladpaiu),
   Bogdan-Andrei Iancu (@bogdan-iancu).

   Documentation Copyrights:

   Copyright © 2009 Andrei Dragus

   Copyright © 2009 Voice Sistem SRL
