Browse code

doc Remove SVN ID's, remove history, change "SIP-router" and "ser" to "Kamailio"

Olle E. Johansson authored on 10/01/2015 08:47:18
Showing 14 changed files
... ...
@@ -1,9 +1,3 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2007-12-06:	Created by Miklos
6
-
7 1
 SIP-router Configuration Framework
8 2
 
9 3
 1. Overview
... ...
@@ -1,9 +1,3 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2009-05-06  created by andrei
6
-
7 1
 =============================================================
8 2
 = Config migration guide from ser or kamailio to sip-router =
9 3
 =============================================================
... ...
@@ -1,23 +1,23 @@
1
-# $Id$
2
-#
3
-# SIP-router git commit rules
4
-
1
+Kamailio git commit rules
2
+=========================
5 3
 
6 4
 1. Changing other people's code:
7 5
 --------------------------------
8
- - send a patch to the code/module mantainer and/or sr-dev (don't commit changes to code you don't own if you don't have the mantainer's approval)
6
+ - send a patch to the code/module mantainer and/or sr-dev 
7
+   (don't commit changes to code you don't own if you don't have the mantainer's approval)
9 8
 Exceptions:
10 9
  a. compilation (this includes warning) fixes
11 10
  b. bug fixes
12
- c. api changes (some external functions definitions change)
11
+ c. API changes (some external functions definitions change)
13 12
  d. small changes due to a new release in the very near future (allowed only for the release manager)
14 13
 
15 14
 2. Code requirements
16 15
 --------------------
17 16
 2.1 Unstable branch:
18
- - the code must compile (at least on one architecture). If the code does not compile, but you still want to commit it, comment it out (#if 0 ... #endif)
17
+ - the code must compile (at least on one architecture). If the code does not compile, 
18
+   but you still want to commit it, comment it out (#if 0 ... #endif)
19 19
  - the code should compile without warnings (with -Wall) (exceptions: very difficult to avoid warnings)
20
- - follow SIP-router coding style
20
+ - follow Kamailio coding style
21 21
 
22 22
 2.2. Stable branch (everything for unstable branch +)
23 23
 ------------------------------------------------------
... ...
@@ -1,27 +1,22 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2006-09-08  created by andrei
6
-# 2007-06-18  added naptr & friends, dns_srv_lb, more compile options (andrei)
7
-#
8
-
9
-SIP-router and DNS Overview
1
+
2
+Kamailio and DNS Overview
10 3
 ---------------------------
11 4
 
12
- The dns subsystem in sip-router can either directly use libresolv and a combination
13
-  of the locally configured dns server, /etc/hosts and the local Network 
5
+ The DNS subsystem in Kamailio can either directly use libresolv and a combination
6
+  of the locally configured DNS server, /etc/hosts and the local Network 
14 7
   Information Service (NIS/YP a.s.o) or cache the query results (both positive
15 8
   and negative) and look first in its internal cache.
16
- When its internal dns cache is enabled, sip-router can also use dns failover: if
17
-  one destination resolves to multiple addresses sip-router can try all of them until
9
+
10
+ When its internal DNS cache is enabled, Kamailio can also use DNS failover: if
11
+  one destination resolves to multiple addresses Kamailio can try all of them until
18 12
   it finds one to which it can successfully send the packet or it exhausts all 
19
-  of them. sip-router (The tm module to be more precise) uses the DNS failover also 
13
+  of them. Kamailio (The tm module to be more precise) uses the DNS failover also 
20 14
   when the destination host doesn't send any reply to a forwarded invite within the
21 15
   SIP timeout interval (whose value can be configured using the tm fr_timer
22 16
   parameter).
23
-  When SRV based load balancing is enabled sip-router can even do DNS based load 
24
-  balancing (see RFC2782 and the dns_srv_lb option below).
17
+  When SRV based load balancing is enabled Kamailio can even do DNS based load 
18
+  balancing (see RFC2782 and the dns_srv_lb option below). This is using the
19
+  weight value in the DNS SRV record.
25 20
 
26 21
 
27 22
 DNS Cache and Failover Drawbacks
... ...
@@ -29,18 +24,18 @@ DNS Cache and Failover Drawbacks
29 29
 
30 30
  Using the DNS cache and the DNS failover has also some drawbacks: 
31 31
 
32
-  1. only the locally configured DNS server (usually in /etc/resolv.conf) is
33
-  used for the requests (/etc/hosts and the local Network Information Service
34
-  are ignored). 
35
-     Workaround: disable the dns cache (use_dns_cache=off or compile without -DUSE_DNS_CACHE).
32
+  1. Only the locally configured DNS server (usually in /etc/resolv.conf) is
33
+     used for the requests (/etc/hosts and the local Network Information Service
34
+     are ignored). 
35
+     Workaround: disable the DNS cache (use_dns_cache=off or compile without -DUSE_DNS_CACHE).
36 36
 
37
-  2. the DNS cache uses extra memory
37
+  2. The DNS cache uses extra memory
38 38
       Workaround: disable the DNS cache.
39 39
 
40
-  3. the DNS failover introduces a very small performance penalty 
40
+  3. The DNS failover introduces a very small performance penalty 
41 41
      Workaround: disable the DNS failover (use_dns_failover=off).
42 42
 
43
-  4. the DNS failover increases the memory usage (the internal structures
43
+  4. The DNS failover increases the memory usage (the internal structures
44 44
      used to represent the transaction are bigger when the DNS failover support is
45 45
      compiled).
46 46
      Workaround: compile without DNS failover support (-DUSE_DNS_FAILOVER).
... ...
@@ -49,9 +44,9 @@ DNS Cache and Failover Drawbacks
49 49
  
50 50
  On the other hand using the DNS cache saves lots of DNS queries and makes
51 51
  DNS based failover and DNS based load balancing possible. If the destination
52
- blacklist is enabled, sip-router can do failover even if forwarding in stateless 
52
+ blacklist is enabled, Kamailio can do failover even if forwarding in stateless 
53 53
  mode.
54
- In the ideal case with the DNS cache enabled sip-router will do only one query for
54
+ In the ideal case with the DNS cache enabled Kamailio will do only one query for
55 55
  a NAPTR (if enabled) or SRV lookup and then it will use the results for the
56 56
  record's TTL (for example if all the resulting records have 1 minute TTL,
57 57
  the server won't make another query for this domain for 1 minute). Even negative
... ...
@@ -64,29 +59,29 @@ DNS Cache and Failover Drawbacks
64 64
 DNS Resolver Options
65 65
 --------------------
66 66
 
67
- The DNS resolver options control how sip-router will interact with the external
67
+ The DNS resolver options control how Kamailio will interact with the external
68 68
  DNS servers. These options (with the dns_try_ipv6 exception) are passed to
69
- libresolv and are used each time a dns request is made.
69
+ libresolv and are used each time a DNS request is made.
70 70
 
71 71
  The default values are system specific and generally depend on the
72 72
  /etc/resolv.conf content. For servers doing a lot of DNS requests it is
73
- highly recommended to change the default values in the sip-router config file
74
-  (even if using sip-router's internal dns cache).
73
+ highly recommended to change the default values in the Kamailio config file
74
+  (even if using Kamailio's internal DNS cache).
75 75
 
76
-   dns_try_ipv6 = on | off - if on and sip-router listens on at least one ipv6 socket,
76
+   dns_try_ipv6 = on | off - if on and Kamailio listens on at least one ipv6 socket,
77 77
       ipv6 (AAAA) lookups will be performed if the ipv4 (A) lookups fail. 
78 78
       If off only ipv4 (A) lookups will be used.
79
-      Default: on if sip-router is compiled with ipv6 support.
79
+      Default: on if Kamailio is compiled with ipv6 support.
80 80
 
81
-   dns_try_naptr = on | off - if on sip-router will first try a NAPTR lookup for
81
+   dns_try_naptr = on | off - if on Kamailio will first try a NAPTR lookup for
82 82
       destinations that don't have the protocol or port specified and 
83 83
       are not simple ip addresses (as described in RFC 3263). This will 
84 84
       introduce a slight performance penalty and will probably cause extra
85 85
       DNS lookups. For example a lookup for a non-existing domain will
86 86
       produce one extra query: NAPTR(domain), SRV(_sip._udp.domain) 
87 87
       and A/AAAA(domain).
88
-      If the result of a query contains several NAPTR records, sip-router will select
89
-      among them according to the RFC2915 and sip-router preference towards a
88
+      If the result of a query contains several NAPTR records, Kamailio will select
89
+      among them according to the RFC2915 and Kamailio preference towards a
90 90
       specific protocol (see dns_udp_pref, dns_tcp_pref and dns_tls_pref 
91 91
       below). For an RFC3263 compliant configuration (choose the remote side
92 92
       preferred protocol if supported), set dns_udp_pref, dns_tcp_pref and
... ...
@@ -96,17 +91,17 @@ DNS Resolver Options
96 96
    dns_udp_pref = number - udp protocol preference when doing NAPTR lookups.
97 97
       This option works together with dns_tcp_pref, dns_tls_pref and 
98 98
       dns_sctp_pref. If all this options have the same positive value and more
99
-      NAPTR records are available, ser will select the NAPTR record preferred
99
+      NAPTR records are available, Kamailio will select the NAPTR record preferred
100 100
       by the remote side (according to RFC2915). If the values are positive
101
-      but different, ser will select the NAPTR record whose protocol it
101
+      but different, Kamailio will select the NAPTR record whose protocol it
102 102
       prefers the most (the protocol with the highest dns_<proto>_pref
103 103
       number). If there are several NAPTR records with the same preferred
104
-      protocol, ser will select among them based on their order and preference
104
+      protocol, Kamailio will select among them based on their order and preference
105 105
       (see RFC2915).
106 106
       To completely disable selecting a specific protocol, use  a negative
107 107
       number. For example dns_tcp_pref=-1 will completely disable selection
108 108
       of tcp NAPTR records, even if this will result in the NAPTR lookup
109
-      failure. Note: if a protocol is disabled in ser (e.g. tls_disable=1)
109
+      failure. Note: if a protocol is disabled in Kamailio (e.g. tls_disable=1)
110 110
       the corresponding NAPTR records selection will be also disabled,
111 111
       irrespective of the dns_<proto>_preference value.
112 112
       Default: dns_udp_pref=30, dns_tcp_pref=20,  dns_tls_pref=10 and 
... ...
@@ -121,14 +116,14 @@ DNS Resolver Options
121 121
 
122 122
    dns_sctp_pref = number (see dns_udp_pref above)
123 123
 
124
-   dns_retr_time = time - time in s before retrying a dns request.
124
+   dns_retr_time = time - time in s before retrying a DNS request.
125 125
       Default: system specific, depends also on the/etc/resolv.conf content
126 126
       (usually 5 s).
127 127
 
128
-   dns_retr_no = no. - number of dns retransmissions before giving up.
128
+   dns_retr_no = no. - number of DNS retransmissions before giving up.
129 129
       Default: see above (usually 4)
130 130
 
131
-   dns_servers_no = no. - how many dns servers from the ones defined in 
131
+   dns_servers_no = no. - how many DNS servers from the ones defined in 
132 132
       /etc/resolv.conf will be used. Default: all of them.
133 133
 
134 134
    dns_use_search_list= yes/no - if no, the search list in /etc/resolv.conf
... ...
@@ -137,7 +132,7 @@ DNS Resolver Options
137 137
       HINT: even if you don't have a search list defined, setting this option
138 138
       to "no" will still be "faster", because an empty search list is in 
139 139
       fact search "" (so even if the search list is empty/missing there will
140
-      still be 2 dns queries, eg. foo+'.' and foo+""+'.')
140
+      still be 2 DNS queries, eg. foo+'.' and foo+""+'.')
141 141
 
142 142
    dns_search_full_match = yes/no - controls the check of the name part
143 143
       which is found in the answer expanding the searched name before
... ...
@@ -147,11 +142,11 @@ DNS Resolver Options
147 147
       If set to no - no additional check is done.
148 148
       If set to yes - the additional part is checked against the search list.
149 149
 
150
- The maximum time a dns request can take (before failing) is:
151
- (dns_retr_time*dns_retr_no)*(search_list_domains) If dns_try_ipv6 is yes,
150
+ The maximum time a DNS request can take (before failing) is:
151
+ (dns_retr_time*dns_retr_no) * (search_list_domains) If dns_try_ipv6 is yes,
152 152
  mutliply it again by 2.
153 153
 
154
- The option combination that produces the "fastest" dns resolver config
154
+ The option combination that produces the "fastest" DNS resolver config
155 155
   (the "faster" in the sense that it gives up the quickest) is:
156 156
 
157 157
       dns_try_ipv6=no
... ...
@@ -160,19 +155,19 @@ DNS Resolver Options
160 160
       dns_servers_no=1
161 161
       dns_use_search_list=no
162 162
 
163
- The recommended dns configuration is to have a "close" dns caching recursive
164
- server configured in /etc/resolv.conf, set the dns resolver options in ser's
165
- config as in the above example and enable the dns cache (in ser).
163
+ The recommended DNS configuration is to have a "close" DNS caching recursive
164
+ server configured in /etc/resolv.conf, set the DNS resolver options in Kamailio's
165
+ config as in the above example and enable the DNS cache (in Kamailio).
166 166
  Pay particular attention to dns_servers_no and dns_use_search_list. It's a
167 167
  good idea to make sure you don't need / use the search list or more then one
168
- dns server (to avoid unnecessary extra lookups).
168
+ DNS server (to avoid unnecessary extra lookups).
169 169
 
170 170
 
171 171
 DNS Resolver Compile Options
172 172
 ----------------------------
173 173
 
174 174
    USE_NAPTR - if defined the naptr lookup support will be compiled in.
175
-      NAPTR support still has to be enabled from ser's config file (it's
175
+      NAPTR support still has to be enabled from Kamailio's config file (it's
176 176
       off by default).
177 177
 
178 178
    RESOLVE_DBG - if defined, the resolver will be very verbose: it will log
... ...
@@ -185,8 +180,8 @@ DNS Resolver Compile Options
185 185
 DNS Cache and Failover Config Variables
186 186
 ---------------------------------------
187 187
 
188
-   use_dns_cache = on | off - if off the dns cache won't be used (all dns
189
-      lookups will result into a dns request).  When on all the dns request
188
+   use_dns_cache = on | off - if off the DNS cache won't be used (all dns
189
+      lookups will result into a DNS request).  When on all the DNS request
190 190
       results will be cached.
191 191
       WARNING: when enabled /etc/hosts will be completely bypassed, all the dns
192 192
       request will go directly to the system configured (resolv.conf) dns
... ...
@@ -200,17 +195,17 @@ DNS Cache and Failover Config Variables
200 200
       re-tried using the next ip/record. In tm's case a new branch will be
201 201
       created for each new send attempt.
202 202
       Default: off.
203
-   Depends on use_dns_cache being on. If tm is used along with dns failover is
203
+   Depends on use_dns_cache being on. If tm is used along with DNS failover is
204 204
    recommended to also turn on dst_blacklist.
205 205
 
206 206
    dns_srv_lb = on | off or
207
-   dns_srv_loadbalancing = on | off - if on instead of doing simple dns 
208
-        failover (like above), ser will load balance requests to different srv
209
-        records of the same priority based on the srv records weights (like 
207
+   dns_srv_loadbalancing = on | off - if on instead of doing simple DNS 
208
+        failover (like above), Kamailio will load balance requests to different srv
209
+        records of the same priority based on the SRV records weights (like 
210 210
         described in RFC2782). For a destination which has different priorities
211
-        for all its srv records, this option will be equivalent with simple
212
-        dns failover.
213
-        Note: this option requires having dns failover enabled (see 
211
+        for all its SRV records, this option will be equivalent with simple
212
+        DNS failover.
213
+        Note: this option requires having DNS failover enabled (see 
214 214
         use_dns_failover above).
215 215
         Default: off.
216 216
 
... ...
@@ -229,13 +224,13 @@ DNS Cache and Failover Config Variables
229 229
    dns_tls_pref =  number - shared with the resolver (see resolver 
230 230
         description).
231 231
 
232
-   dns_cache_flags = dns cache specific resolver flags, used for overriding
232
+   dns_cache_flags = DNS cache specific resolver flags, used for overriding
233 233
      the default behaviour (low level).
234 234
       Possible values:
235
-         1 - ipv4 only: only DNS A requests are performed, even if ser listens
235
+         1 - ipv4 only: only DNS A requests are performed, even if Kamailio listens
236 236
                         also on ipv6 addresses.
237 237
          2 - ipv6 only: only DNS AAAA requests are performed. Ignored if
238
-                        dns_try_ipv6 is off or ser doesn't listen on any ipv6
238
+                        dns_try_ipv6 is off or Kamailio doesn't listen on any ipv6
239 239
                         address.
240 240
          4 - prefer ipv6: try first to resolve a host name to an ipv6 address
241 241
                           (DNS AAAA request) and only if this fails try an ipv4
... ...
@@ -257,10 +252,10 @@ DNS Cache and Failover Config Variables
257 257
       dns_cache_max_ttl will be used instead.
258 258
       Default: MAXINT
259 259
 
260
-   dns_cache_mem = maximum memory used for the dns cache in Kb.
260
+   dns_cache_mem = maximum memory used for the DNS cache in Kb.
261 261
       Default: 500 Kb
262 262
 
263
-   dns_cache_gc_interval = how often (in s) the dns cache will be garbage 
263
+   dns_cache_gc_interval = how often (in s) the DNS cache will be garbage 
264 264
       collected.
265 265
       Default:  120 s.
266 266
       
... ...
@@ -270,37 +265,37 @@ DNS Cache and Failover Config Variables
270 270
       ones. The last-recently used entries are deleted first.
271 271
       Default: no
272 272
 
273
-   dns_cache_init = on | off - if off, the dns cache is not initialized
273
+   dns_cache_init = on | off - if off, the DNS cache is not initialized
274 274
       at startup and cannot be enabled runtime, that saves some memory.
275 275
       Default: on
276 276
 
277 277
 DNS Cache Compile Options
278 278
 -------------------------
279 279
 
280
-   USE_DNS_CACHE - if defined the dns cache support will be compiled in 
280
+   USE_DNS_CACHE - if defined the DNS cache support will be compiled in 
281 281
       (default). If not needed/wanted the dns_cache can be disabled from the
282
-      ser's config file. The only advantages for not compiling the dns cache
282
+      Kamailio's config file. The only advantages for not compiling the DNS cache
283 283
       support is a slight decrease of the executable size and an extremely 
284
-      small performance increase (1 less comparison per dns request).
284
+      small performance increase (1 less comparison per DNS request).
285 285
 
286
-   USE_DNS_FAILOVER - if defined the dns failover support will be compiled in.
287
-      (default). Compiling the dns failover support has a few disadvantages,
286
+   USE_DNS_FAILOVER - if defined the DNS failover support will be compiled in.
287
+      (default). Compiling the DNS failover support has a few disadvantages,
288 288
       see the "Drawbacks" section.
289 289
 
290 290
    DNS_SRV_LB  - if defined (default) support for load balancing using 
291
-       srv records weights (as described in RFC2782) will be compiled in.
292
-       Note however that it still must be enabled from the ser config, it's
291
+       SRV records weights (as described in RFC2782) will be compiled in.
292
+       Note however that it still must be enabled from the Kamailio config, it's
293 293
        disabled by default (see the dns_srv_lb config option).
294 294
 
295 295
    USE_NAPTR  - (shared with the resolver)  if defined NAPTR support will
296 296
        be compiled in (default). Note that even if compiled, NAPTR support
297
-       must be enabled also from the ser config (see the dns_try_naptr option).
297
+       must be enabled also from the Kamailio config (see the dns_try_naptr option).
298 298
 
299 299
    NAPTR_CACHE_ALL_ARS - if defined all the additional records in a NAPTR
300
-       answer will be cached. Normally ser would cache only "related" records
300
+       answer will be cached. Normally Kamailio would cache only "related" records
301 301
        (records that are directly referred), but for answers with lots of 
302 302
         A/AAAA records it might happen that not all of the SRV records will fit
303
-       in the AR section. In this case, without this compile option ser will 
303
+       in the AR section. In this case, without this compile option Kamailio will 
304 304
        not cache the un-referred A/AAAA records. BY default this option is
305 305
        disabled.
306 306
 
... ...
@@ -312,10 +307,10 @@ DNS Cache Compile Options
312 312
        If this option is not defined (experimental), everything in the AR
313 313
        section will be added to the cache.
314 314
 
315
-   DNS_CACHE_DEBUG - if defined the dns cache will be very verbose (it will
315
+   DNS_CACHE_DEBUG - if defined the DNS cache will be very verbose (it will
316 316
        log lots of messages at the L_DBG levell).
317 317
  
318
- Note: To remove a compile options,  edit sip-router's Makefile.defs and remove it 
318
+ Note: To remove a compile options,  edit Kamailio's Makefile.defs and remove it 
319 319
    from DEFS list. To add a compile options add it to the make command line,
320 320
      e.g.: make proper; make all extra_defs=-DUSE_DNS_FAILOVER
321 321
    or for a permanent solution, edit Makefile.defs and add it to DEFS 
... ...
@@ -1,10 +1,3 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2006-09-08  created by andrei
6
-#
7
-
8 1
 Destination blacklist Overview
9 2
 ------------------------------
10 3
 
... ...
@@ -1,19 +1,12 @@
1
-# $Id$
2
-#
3
-# History:
4
-#---------
5
-#  2003-03-11  created by andrei
6
-#  2006-04-04  minor archs updates, added lock_try(..)  (andrei)
7 1
 
8
-
9
-SIP-router locking interface
2
+Kamailio locking interface
10 3
 ============================
11 4
 
12 5
 1. Why use it?
13 6
 --------------
14 7
 
15 8
 The main reason for creating it was to have a single transparent interface to various locking methods. 
16
-For example right now SIP-router uses the following locking methods, depending on their availability on the 
9
+For example right now Kamailio uses the following locking methods, depending on their availability on the 
17 10
 target system:
18 11
 	FAST_LOCK - fast inline assembly locks, defined in fast_lock.h. They are currently available for 
19 12
 	x86, x86_64, sparc, sparc64, arm , armv6 (no smp mode supported yet), ppc, ppc64, mips, mips64 
... ...
@@ -39,7 +32,7 @@ target system:
39 39
 -----------------
40 40
 
41 41
 First of all you have to include locking.h. Then when compiling the code one or all of FAST_LOCK, 
42
-USE_PTHREAD_MUTEX, USE_PTHREAD_SEM or USE_SYSV_SEM must be defined (the SIP-router Makefile.defs takes 
42
+USE_PTHREAD_MUTEX, USE_PTHREAD_SEM or USE_SYSV_SEM must be defined (the Kamailio Makefile.defs takes 
43 43
 care of this, you should need to change it only for new arhitectures or compilers).
44 44
 
45 45
 locking.h defines 2 new types: gen_lock_t and lock_set_t.
... ...
@@ -7,7 +7,7 @@
7 7
                          Ondrej Martinek <ondra@iptel.org>
8 8
                                               January 2009
9 9
 
10
-This document contains the short description of the logging API in SIP-router
10
+This document contains the short description of the logging API in Kamailio
11 11
 for developers.
12 12
 
13 13
 Source files:
... ...
@@ -121,7 +121,7 @@ Source files:
121 121
 !!! IMPORTANT! READ ME!
122 122
 !!!
123 123
 !!!  These changes (mainly the first two) require reformating of the most log
124
-!!!  messages in SIP-router core and module source files.  This step can be done
124
+!!!  messages in Kamailio core and module source files.  This step can be done
125 125
 !!!  automatically by running "scripts/logging/fix-logs-all" script BUT it
126 126
 !!!  was NOT originally performed because it would have generated too many
127 127
 !!!  changes in CVS which was discouraged by Andrei.  Instead, the developers
... ...
@@ -130,5 +130,3 @@ Source files:
130 130
 !!! IMPORTANT! READ ME!
131 131
 !!!  
132 132
 
133
-$Id$
... ...
@@ -1,7 +1,7 @@
1
-Management API's in SIP-router
1
+Management API's in Kamailio
2 2
 ------------------------------
3 3
 
4
-SIP-router has an API based on RPC. This allows modules and core to expose commands that can be 
4
+Kamailio has an API based on RPC. This allows modules and core to expose commands that can be 
5 5
 issued by external applications. Commands can change states, read status variables or expose
6 6
 internal structures.
7 7
 
... ...
@@ -14,7 +14,7 @@ you can adapt the interface to one of several protocols supported:
14 14
 
15 15
 The MI interfaces can often run over Unix fifo sockets, UDP or TCP connections.
16 16
 
17
-The "sercmd" application is the command line tool used to connect to SIP-router
17
+The "kamcmd" application is the command line tool used to connect to Kamailio
18 18
 over the command line. Use it to discover available commands.
19 19
 
20 20
 For backwards compatibilty, the kamctrl and kamdbctrl commands are still supported.
... ...
@@ -25,7 +25,7 @@ web site in the wiki section.
25 25
 Modules
26 26
 -------
27 27
 
28
-mi_rpc		Exports Kamailio's MI interface over SIP-router's RPC interface
28
+mi_rpc		Exports Kamailio's MI interface over Kamailio's RPC interface
29 29
 xmlrpc		Exports the RPC interface using XML-rpc
30 30
 ctl		Implements the binrpc transport interface for SER rpcs
31 31
 		Also implements the old SER fifo-based management interface.
... ...
@@ -1,12 +1,5 @@
1
-#$Id$
2
-#
3
-#
4
-# History
5
-#--------
6
-#  2007-06-07  created by Andrei Pelinescu <andrei@iptel.org>
7
-#
8
-
9
-SIP-router Module intialization description
1
+
2
+Kamailio Module intialization description
10 3
 ===========================================
11 4
 
12 5
 This document is a very brief overview on what possibilities are for a module
... ...
@@ -24,21 +17,21 @@ mod_init is called after parsing the config, loading all the modules and
24 24
 going into daemon mode. mod_init is called in the main process context,
25 25
 before changing the uid or gid (so if you want to do something requiring
26 26
 higher privileges this is the place to do it). This is not the right place
27
-to fork more SIP-router processes, but instead is the only place where one can 
27
+to fork more Kamailio processes, but instead is the only place where one can 
28 28
 register future forked processes (see register_procs()).
29 29
 
30 30
 mod_init is ideal for initializing per process variables, assuming that you
31
-don't need different values for each SIP-router child (in which case see 
31
+don't need different values for each Kamailio child (in which case see 
32 32
 mod_child_init below) and shared memory variables assuming that you don't 
33
-need SIP-router's number of processes (which is not available at this point).
33
+need Kamailio's number of processes (which is not available at this point).
34 34
 
35 35
 
36 36
 mod_child_init
37 37
 ---------------
38 38
 
39
-mod_child_init is called for each forked SIP-router process with 2 exceptions:
39
+mod_child_init is called for each forked Kamailio process with 2 exceptions:
40 40
  - it's called for the main process too and it's called twice
41
- - it's not called for SIP-router processes forked with PROC_NOCHLDINIT
41
+ - it's not called for Kamailio processes forked with PROC_NOCHLDINIT
42 42
 
43 43
 mod_child_init is always called after mod_init. It takes one parameter, the
44 44
  process rank. This parameter can be used to differentiate between normal
... ...
@@ -48,7 +41,7 @@ There are two very special rank values: PROC_INIT (as of 2007-06-06) and
48 48
 mod_child_init(PROC_INIT) is the first mod_child_init call made, and it's
49 49
  guaranteed to happen before any child process is forked. The process context
50 50
   is the "main" process (as for mod_init), but this time we have a little bit
51
- more information: we know the number of SIP-router processes. This is the right
51
+ more information: we know the number of Kamailio processes. This is the right
52 52
   place to initialize things like shared arrays[get_max_procs()].
53 53
 Note also that everything done here will be inherited in all the future
54 54
  children processes (since it's executed in the "main" process context before
... ...
@@ -56,14 +49,14 @@ Note also that everything done here will be inherited in all the future
56 56
 
57 57
 mod_child_init(PROC_MAIN) is another call that is done in the same "main"
58 58
  process context. This call happens just before initializing the main tcp
59
-  process. This is the only right place for forking more SIP-router processes
59
+  process. This is the only right place for forking more Kamailio processes
60 60
   (see fork_process()). WARNING: the context is the same "main" process as
61 61
  for mod_child_init(PROC_INIT) and mod_init() so care must be taken not to
62 62
  initialize things twice or three times for the "main" process.
63 63
 
64 64
 Except for the "main" process case mod_child_init(rank) will be called only
65 65
 once for each new child process, just after forking. A positive non-zero rank
66
- means the current process is a normal SIP-router process and a negative rank has
66
+ means the current process is a normal Kamailio process and a negative rank has
67 67
   some special meaning (grep PROC_ sr_module.h for more info).
68 68
 mod_child_init(rank) is the best place for initializing per process variables,
69 69
  opening per process database connections, new sockets a.s.o. Note however
... ...
@@ -76,7 +69,7 @@ mod_child_init(rank) is the best place for initializing per process variables,
76 76
 mod_child_init in the no-fork case
77 77
 ----------------------------------
78 78
 
79
-If SIP-router is started in no-fork mode it will try to start as few processes as
79
+If Kamailio is started in no-fork mode it will try to start as few processes as
80 80
 possible (as of this date it will start 3 processes the main process and the
81 81
 2 timers). In this case mod_child_init() will be called 3 times in the
82 82
 same "main" process context: mod_child_init(PROC_INIT);
... ...
@@ -84,7 +77,7 @@ mod_child_init(PROC_MAIN) and mod_child_init(1) (since the first process is
84 84
 also the "main" one).
85 85
 
86 86
 
87
-Forking new SIP-router processes from a module
87
+Forking new Kamailio processes from a module
88 88
 ---------------------------------------
89 89
 
90 90
 static int mod_init()
... ...
@@ -140,7 +133,7 @@ mod_child_init(PROC_INIT)
140 140
   process.
141 141
 
142 142
 mod_child_init(PROC_MAIN)
143
- - the only place from where another SIP-router process can be forked 
143
+ - the only place from where another Kamailio process can be forked 
144 144
    (see fork_process  ()), but remember first to register the number of 
145 145
    to-be-forked processes in mod_init()
146 146
 
... ...
@@ -1,5 +1,3 @@
1
-# $Id$
2
-#
3 1
 # parse headers api changes
4 2
 #
5 3
 # 2004.02.23  created (andrei)
... ...
@@ -1,5 +1,3 @@
1
-$Id$
2
-
3 1
 iptel.org SIP Express Router (SER) is a high-performance, 
4 2
 configurable, free server implementing Session Initiation 
5 3
 Protocol (SIP, RFC3216). SIP is a signaling protocol that 
... ...
@@ -1,6 +1,4 @@
1
-# $Id$
2
-#
3
-# SIP-router Coding Style
1
+# Kamailio Coding Style
4 2
 #
5 3
 #  2004-06-07  Andrei Pelinescu - Onciul <pelinescu-onciul@fokus.franhofer.de>
6 4
 
... ...
@@ -47,7 +45,7 @@ Doxygen
47 47
 -------
48 48
 - try to always add doxygen comments to functions and variables declared in your code. 
49 49
   Especially remember to document public functions, functions and structures
50
-  that are part of the SIP-router API.
50
+  that are part of the Kamailio API.
51 51
 - each file needs a declaration of the purpose of the file in the \file section
52 52
 
53 53
 If you are editing someone elses code, try to use his coding conventions
... ...
@@ -1,17 +1,11 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2006-01-26  created by andrei
6
-
7
-SIP-router TCP Tunning/monitoring for lots of open connections
1
+Kamailio TCP Tunning/monitoring for lots of open connections
8 2
 ==============================================================
9 3
 
10 4
 0. Introduction
11 5
 ----------------
12 6
 
13 7
 This document describes very briefly various settings that should improve
14
-sip-router+TCP performance for sites handling a lot of TCP traffic (> 1000 open
8
+Kamailio TCP performance for sites handling a lot of TCP traffic (> 1000 open
15 9
 connections or very high connection/disconnection rates).
16 10
 
17 11
 For now it deals only with Linux specific optimizations.
... ...
@@ -77,7 +71,6 @@ iptables  - remove the ip_conntrack module (it limits the maximum tcp
77 77
   all the iptables modules.
78 78
 
79 79
 
80
-
81 80
 2. Monitoring (values to watch for)
82 81
 -----------------------------------
83 82
 
... ...
@@ -96,15 +89,15 @@ fs.inode-state  -  format: nr. allocated, nr. free, preshrink
96 96
 /proc/net/sockstat
97 97
 
98 98
 
99
-3. Sip-router settings
99
+3. Kamailio settings
100 100
 ----------------------
101 101
 
102 102
 - Don't forget to increase tcp_max_connections and the amount of shared memory
103
-- You should increase the number of ser "tcp_children" processes (-N no)
103
+- You should increase the number of Kamailio "tcp_children" processes (-N no)
104 104
   As a rule of thumb, (maximum simultaneous connections)/2000 should be ok
105 105
 - You might have to decrease TCP_BUF_SIZE to a smaller value (e.g 8K)
106 106
 - You might want to increase PKG_MEM_POOL_SIZE (for large queues)
107 107
 
108
-- You might need to increase the maximum open fds limit before starting ser
108
+- You might need to increase the maximum open fds limit before starting Kamailio
109 109
   (e.g. ulimit -n 1000000)
110 110
 
... ...
@@ -1,18 +1,12 @@
1
-# $Id$
2
-#
3
-# History:
4
-# --------
5
-# 2005-11-30    created by andrei
6 1
 
7
-
8
-SIP-router :: timer interface
2
+Kamailio :: timer interface
9 3
 =============================
10 4
 
11 5
 
12 6
 1. Introduction
13 7
 ---------------
14 8
 
15
-SIP-router's timer interface is based on a 3 level hierarchical timing wheel
9
+Kamailio's timer interface is based on a 3 level hierarchical timing wheel
16 10
 (see [1]). Most timeouts will go in the first "wheel" (all timeouts < 1<<14 
17 11
 ticks, which by default mean 1024 s). Each wheel acts as a circular buffer.
18 12
 The big advantage of this scheme is that most of the time you just run all the 
... ...
@@ -78,10 +72,12 @@ timer_free(t);
78 78
 
79 79
 To use a timer you need a timer_ln structure. This structure must be stored
80 80
  in shared memory.
81
-You can either use timer_alloc() which will return a pointer to a shared memory allocated timer_ln structure or you can "attach" timer_ln as a member to one
81
+You can either use timer_alloc() which will return a pointer to a shared memory 
82
+allocated timer_ln structure or you can "attach" timer_ln as a member to one
82 83
  of your structures which is already stored in the shared memory.
83 84
 
84
-The timer_ln structure must be always initialized. Use the timer_init(...) macro for this. To the timer_init macro takes as parameters a pointer to the timer_ln structure, a pointer to a timer_handler_f function, a void* parameter for this
85
+The timer_ln structure must be always initialized. Use the timer_init(...) macro for this. 
86
+To the timer_init macro takes as parameters a pointer to the timer_ln structure, a pointer to a timer_handler_f function, a void* parameter for this
85 87
  function and some timer flags.
86 88
 Example:
87 89
 
... ...
@@ -145,15 +141,26 @@ timer_add(&f->timer, rand());
145 145
 timer_del(&f->timer); /* if the timer is already expired => f is already
146 146
                          deleted => problems */
147 147
 
148
-The above timer_del/free_in_one_shot_timer race example is very simple, but consider that you can have much more complex scenarios, when timer_del can be called from different processes on some asynchronous events. If this looks like your intended usage, make sure you use some  reference counters or some other protection mechanism to avoid the above race.
148
+The above timer_del/free_in_one_shot_timer race example is very simple, but 
149
+consider that you can have much more complex scenarios, when timer_del can be 
150
+called from different processes on some asynchronous events. If this looks like your 
151
+intended usage, make sure you use some  reference counters or some other 
152
+protection mechanism to avoid the above race.
149 153
 
150 154
 4.5 timer_allow_del
151 155
 -------------------
152 156
 
153
-Marks a timer as "to be deleted when the handler ends", usefull when the timer handler knows it won't prolong the timer anymore (it will return 0) and will do some time consuming work. Calling this function will cause simultaneous timer_dels to return immediately (they won't  wait anymore for the timer handle to finish). It will also allow  self-deleting from the timer handle without logging a bug.
154
- WARNING: - if you rely on timer_del to know when the timer handle execution finishes (e.g. to free resources used in the timer handle), don't use this function.
155
-          - call this function only if this is your last timer handle run (the timer handle will return 0)
156
-          - this function can be called only from a timer handle (in timer context), all other calls will have no effect and will log a bug message
157
+Marks a timer as "to be deleted when the handler ends", usefull when the timer handler 
158
+knows it won't prolong the timer anymore (it will return 0) and will do some time 
159
+consuming work. Calling this function will cause simultaneous timer_dels to return 
160
+immediately (they won't  wait anymore for the timer handle to finish). 
161
+It will also allow  self-deleting from the timer handle without logging a bug.
162
+ WARNING: - if you rely on timer_del to know when the timer handle execution 
163
+	    finishes (e.g. to free resources used in the timer handle), don't use this function.
164
+          - call this function only if this is your last timer handle run
165
+	    (the timer handle will return 0)
166
+          - this function can be called only from a timer handle (in timer context), 
167
+  	    all other calls will have no effect and will log a bug message
157 168
 
158 169
 
159 170
 4.6 Getting the ticks value
... ...
@@ -179,26 +186,30 @@ TICKS_TO_S(t)  /* converts from ticks to s, rounded down */
179 179
 4.8 Ticks value comparison
180 180
 ---------------------------
181 181
 
182
-The ticks value can (and will) overflow so ticks values should never be compared directly (e.g. ticks1<ticks2). To compare them include timer_ticks.h and use
183
- one of the macros:
182
+The ticks value can (and will) overflow so ticks values should never be compared directly
183
+(e.g. ticks1<ticks2). To compare them include timer_ticks.h and use
184
+one of the macros:
184 185
 
185 186
 TICKS_LT(t1, t2)  /*  t1 < t2 */
186 187
 TICKS_GT(t1, t2)  /*  t1 > t2 */
187 188
 TICKS_LE(t1, t2)  /*  t1 <= t2 */
188 189
 TICKS_GE(t1, t2)  /*  t1 >= t2 */
189 190
 
190
-These macros work as long as the difference between t1 and t2 is less then 2^(sizeof(ticks_t)*8-1). For the default TIMER_TICKS_HZ values, this means 4.25 years.
191
+These macros work as long as the difference between t1 and t2 is less than 2^(sizeof(ticks_t)*8-1). 
192
+For the default TIMER_TICKS_HZ values, this means 4.25 years.
191 193
 
192 194
 4.9 Backward compatibility
193 195
 --------------------------
194 196
 
195
-The old  register_timer and get_ticks() are still supported for backward compatibility. This means that you don't have to change your existing working code.
197
+The old  register_timer and get_ticks() are still supported for backward compatibility. 
198
+This means that you don't have to change your existing working code.
196 199
 
197 200
 
198 201
 5.0 Debugging
199 202
 -------------
200 203
 
201
-The timers have built-in debugging information. To activate it you only need to define TIMER_DEBUG (recompile ser with make CC_EXTRA_OPTS=-DTIMER_DEBUG all).
204
+The timers have built-in debugging information. To activate it you only need to
205
+define TIMER_DEBUG (recompile Kamailio with make CC_EXTRA_OPTS=-DTIMER_DEBUG all).
202 206
 The timer debug log level is by default L_WARN. [ FIXME: add it as script option]
203 207
 TIMER_DEBUG enables extra sanity checks and it will log a lot of information
204 208
  (like the caller of timer_* functions, where a timer was added a.s.o).