LOCALCACHE

Anca-Maria Vamanu

OpenSIPS

Edited by

Anca-Maria Vamanu

Edited by

Vladut-Stefan Paiu

Revision History
Revision $Revision: 5901 $$Date$

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. exec_threshold (int)
1.3.3. cache_clean_period (int)
1.3.4. Exported Functions
1.3.5. Exported MI Functions

List of Examples

1.1. Set cache_table_size parameter
1.2. Set exec_threshold parameter
1.3. Set cache_clean_period parameter
1.4. cache_remove_chunk usage

Chapter 1. Admin Guide

1.1. Overview

This module is an implementation of a local cache system designed as a hash table. It uses the Key-Value interface exported by OpenSIPS core.

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("cachedb_local", "cache_table_size", 10)
...
	

1.3.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.2. Set exec_threshold parameter

...
modparam("cachedb_local", "exec_threshold", 100000)
...
	

1.3.3. 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.3. Set cache_clean_period parameter

...
modparam("cachedb_local", "cache_clean_period", 1200)
...
	

1.3.4. Exported Functions

1.3.4.1.  cache_remove_chunk(glob)

Remove all keys from local cache that match the glob pattern

This function can be used from all routes

Example 1.4. cache_remove_chunk usage

	...
	cache_remove_chunk("myinfo_*");
	...
	

1.3.5. Exported MI Functions

1.3.5.1. cache_remove_chunk

Removes all local cache entries that match the provided glob param.

Parameters :

  • glob - keys that match glob will be removed

MI FIFO Command Format:

		:cache_remove_chunk:_reply_fifo_file_
		keyprefix*
		_empty_line_