LOCALCACHE

Anca-Maria Vamanu

   OpenSIPS

Edited by

Anca-Maria Vamanu

   Copyright © 2009 Anca-Maria
   Vamanu
   Revision History
   Revision $Revision: 5906 $ $Date: 2009-07-21 10:45:05 +0300
                              (Tue, 21 Jul 2009) $
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSIPS Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. cache_table_size (int)
              1.3.2. cache_clean_period (int)
              1.3.3. Exported Functions

   List of Examples

   1.1. Set cache_table_size parameter
   1.2. Set cache_clean_period parameter

Chapter 1. Admin Guide

1.1. Overview

   This module is an implementation of a local cache system
   designed as a hash table. It registers the three functions for
   storing, fetching and removing a value to the core memcache
   management interface.

1.2. Dependencies

1.2.1. OpenSIPS Modules

   None.

1.2.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running OpenSIPS with this module loaded:
     * none

1.3. Exported Parameters

1.3.1. cache_table_size (int)

   The size of the hash table. This parameter will be used as the
   power of 2 when computing table size.

   Default value is "9 (512)".

   Example 1.1. Set cache_table_size parameter
...
modparam("localcache", "cache_table_size", 10)
...

1.3.2. cache_clean_period (int)

   The time interval in seconds at which to go through all the
   records and delete the expired ones.

   Default value is "600 (10 minutes)".

   Example 1.2. Set cache_clean_period parameter
...
modparam("localcache", "cache_clean_period", 1200)
...

1.3.3. Exported Functions

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