[sr-dev] git:4.3:6ebecf0e: mtree: readme regenerated

Module: kamailio Branch: 4.3 Commit: 6ebecf0eb1ec1c171adda651ce4aff775cd75547 URL: https://github.com/kamailio/kamailio/commit/6ebecf0eb1ec1c171adda651ce4aff7… Author: Daniel-Constantin Mierla <miconda(a)gmail.com> Committer: Daniel-Constantin Mierla <miconda(a)gmail.com> Date: 2015-06-09T10:33:36+02:00 mtree: readme regenerated (cherry picked from commit c36b93f61a7fe76321aab8e62e1bbeee5122c5ed) --- Modified: modules/mtree/README --- Diff: https://github.com/kamailio/kamailio/commit/6ebecf0eb1ec1c171adda651ce4aff7… Patch: https://github.com/kamailio/kamailio/commit/6ebecf0eb1ec1c171adda651ce4aff7… --- diff --git a/modules/mtree/README b/modules/mtree/README index 28dd6d8..2d2dbed 100644 --- a/modules/mtree/README +++ b/modules/mtree/README @@ -20,9 +20,9 @@ Juha Heinanen <jh(a)tutpro.com> - Copyright (c) 2010 Daniel-Constantin Mierla (asipto.com) + Copyright © 2010 Daniel-Constantin Mierla (asipto.com) - Copyright (c) 2011 Juha Heinanen + Copyright © 2011 Juha Heinanen __________________________________________________________________ Table of Contents @@ -130,8 +130,16 @@ Chapter 1. Admin Guide 1. Overview - This module loads data indexed by prefixes from database and returns - associated string or precompiled value. + This module loads (prefix, value) records from database and indexes + them in a named memory tree. Name of the tree is specified for each + record or as module parameter. + + It exports to configuration file functions to match against in-memory + trees and return the values (raw or precompiled) associated with + matched prefixes. + + The maximum size of the prefix is limited internally to 63, database + table definition may enforce lower maximum size. 2. Dependencies @@ -323,7 +331,7 @@ modparam("mtree", "mt_allow_duplicates", 1) 4.1. mt_match(mtree, pv, mode) -4.1. mt_match(mtree, pv, mode) +4.1. mt_match(mtree, pv, mode) Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value of 'mode' is NOT 2, sets a value of the longest matching prefix to @@ -347,7 +355,7 @@ mt_match("mytree", "$rU", "0"); 5.3. mt_summary 5.4. mt_match -5.1. mt_list +5.1. mt_list List content of a tree. @@ -361,7 +369,7 @@ mt_match("mytree", "$rU", "0"); _mtname_ _empty_line_ -5.2. mt_reload +5.2. mt_reload Reload mtree from database. @@ -376,7 +384,7 @@ mt_match("mytree", "$rU", "0"); _mtname_ _empty_line_ -5.3. mt_summary +5.3. mt_summary List usage summary for all trees. @@ -388,7 +396,7 @@ mt_match("mytree", "$rU", "0"); :mt_summary:_reply_fifo_file_ _empty_line_ -5.4. mt_match +5.4. mt_match Match prefix value against mtree. @@ -412,7 +420,7 @@ mt_match("mytree", "$rU", "0"); 6.2. mtree.reload 6.3. mtree.match -6.1. mtree.summary +6.1. mtree.summary List usage summary for all trees or for the tree whose name is given as parameter. @@ -420,7 +428,7 @@ mt_match("mytree", "$rU", "0"); Parameters: * _mtree_ - (optional) the name of the tree. -6.2. mtree.reload +6.2. mtree.reload Reload mtree from database to memory. @@ -428,7 +436,7 @@ mt_match("mytree", "$rU", "0"); * _mtree_ - name of mtree or empty string meaning all mtrees -6.3. mtree.match +6.3. mtree.match Match prefix value against mtree