Debian Codegraph @

src/modules/topos_htable/README

raw
1 TOPOS_HTABLE Module
2
3 Edited by
4
5 Stefan Mititelu
6
7 <[email protected]>
8
9 Copyright © 2024 kamailio.org
10
11 Copyright © 2024 net2phone.com
12 __________________________________________________________________
13
14 Table of Contents
15
16 1. Admin Guide
17
18 1. Overview
19 2. Dependencies
20
21 2.1. Kamailio Modules
22 2.2. External Libraries or Applications
23
24 3. Parameters
25
26 3.1. topos_htable_dialog (string)
27 3.2. topos_htable_transaction (string)
28 3.3. topos_htable_base64 (int)
29
30 List of Examples
31
32 1.1. Set topos_htable_dialog parameter
33 1.2. Set topos_htable_transaction parameter
34 1.3. Set topos_htable_base64 parameter
35
36 Chapter 1. Admin Guide
37
38 Table of Contents
39
40 1. Overview
41 2. Dependencies
42
43 2.1. Kamailio Modules
44 2.2. External Libraries or Applications
45
46 3. Parameters
47
48 3.1. topos_htable_dialog (string)
49 3.2. topos_htable_transaction (string)
50 3.3. topos_htable_base64 (int)
51
52 1. Overview
53
54 This module offers storage support for topos module using htable
55 module.
56
57 2. Dependencies
58
59 2.1. Kamailio Modules
60 2.2. External Libraries or Applications
61
62 2.1. Kamailio Modules
63
64 The following modules must be loaded before this module:
65 * topos module - to bind to as a storage engine.
66 * htable module - to bind to as a shm storage engine.
67
68 2.2. External Libraries or Applications
69
70 No libraries or applications must be installed before running Kamailio
71 with this module loaded.
72
73 3. Parameters
74
75 3.1. topos_htable_dialog (string)
76 3.2. topos_htable_transaction (string)
77 3.3. topos_htable_base64 (int)
78
79 3.1. topos_htable_dialog (string)
80
81 Definition of dialog htable, with all parameters.
82
83 Default value is “topos_dialog=>size=4;autoexpire=7200;dmqreplicate=1”.
84
85 Example 1.1. Set topos_htable_dialog parameter
86 ...
87 modparam("topos_htable", "topos_htable_dialog", "my_dialogs=>size=4;autoexpire=7
88 200;dmqreplicate=1")
89 ...
90
91 3.2. topos_htable_transaction (string)
92
93 Definition of transaction htable, with all parameters.
94
95 Default value is “topos_transaction=>size=4;autoexpire=7200”.
96
97 Example 1.2. Set topos_htable_transaction parameter
98 ...
99 modparam("topos_htable", "topos_htable_transaction", "my_transactions=>size=4;au
100 toexpire=7200")
101 ...
102
103 3.3. topos_htable_base64 (int)
104
105 Enable or disable base64 encoding of htable values. Useful when
106 individual values stored in htable contain delimiter value "|".
107
108 Default value is “0”.
109
110 Example 1.3. Set topos_htable_base64 parameter
111 ...
112 modparam("topos_htable", "topos_htable_base64", 1)
113 ...