User Tools

Site Tools


cookbooks:5.0.x:core

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
cookbooks:5.0.x:core [2017/02/23 20:28]
miconda created
cookbooks:5.0.x:core [2019/03/12 09:55]
mslehto [Core Keywords] quote fix
Line 238: Line 238:
   * #!ifdef NAME - check if a keyword is defined   * #!ifdef NAME - check if a keyword is defined
   * #!ifndef - check if a keyword is not defined   * #!ifndef - check if a keyword is not defined
-  * #!else - swtich to false branch of ifdef/ifndef region+  * #!else - switch to false branch of ifdef/ifndef region
   * #!endif - end ifdef/ifndef region   * #!endif - end ifdef/ifndef region
   * #!trydef - add a define if not already defined   * #!trydef - add a define if not already defined
Line 372: Line 372:
 ===== Core Keywords ===== ===== Core Keywords =====
  
-Keywords specific to SIP messages which can be used mainly in '''if''' expressions.+Keywords specific to SIP messages which can be used mainly in ''if'' expressions.
  
 ==== af ==== ==== af ====
Line 666: Line 666:
 ==== advertised_address ==== ==== advertised_address ====
  
-It can be an IP address or string and represents the address advertised in Via header and +It can be an IP address or string and represents the address advertised in Via header. If empty or not set (default value) the socket
-other destination lumps (e.g RR header). If empty or not set (default value) the socket+
 address from where the request will be sent is used. address from where the request will be sent is used.
  
Line 679: Line 678:
     advertised_address="kamailio.org"     advertised_address="kamailio.org"
  
 +Note: this option may be deprecated and removed in the near future, it is recommended to set **advertise** option for **listen** parameter.
 ==== advertised_port ==== ==== advertised_port ====
  
-The port advertised in Via header and other destination lumps (e.g. RR). If empty or not set (default value) the port from where the message will be sent is used. Same warnings as for 'advertised_address'.+The port advertised in Via header and other destination lumps. If empty or not set (default value) the port from where the message will be sent is used. Same warnings as for 'advertised_address'.
  
 Example of usage: Example of usage:
Line 687: Line 687:
     advertised_port=5080     advertised_port=5080
  
 +Note: this option may be deprecated and removed in the near future, it is recommended to set **advertise** option for **listen** parameter.
 ==== alias ==== ==== alias ====
  
Line 790: Line 791:
 Examples of usage: Examples of usage:
  
-  * debug=3: print all log messages. This is only usefull for debugging of problems. Note: this produces a lot of data and therefore should not be used on production servers (on a busy server this can easily fill up your hard disk with log messages)+  * debug=3: print all log messages. This is only useful for debugging of problems. Note: this produces a lot of data and therefore should not be used on production servers (on a busy server this can easily fill up your hard disk with log messages)
   * debug=0: This will only log warning, errors and more critical messages.   * debug=0: This will only log warning, errors and more critical messages.
   * debug=-6: This will disable all log messages.   * debug=-6: This will disable all log messages.
Line 984: Line 985:
 Prototype: **loadmodule "modulepath"** Prototype: **loadmodule "modulepath"**
  
-If modulepath is only modulename or modulename.so, then Kamailio will try to search also for **modulename/modulename.so**, very useful when usining directly the version compiled in the source tree.+If modulepath is only modulename or modulename.so, then Kamailio will try to search also for **modulename/modulename.so**, very useful when using directly the version compiled in the source tree.
  
 Example of usage: Example of usage:
Line 1539: Line 1540:
 ==== version_table ==== ==== version_table ====
  
-Set the name of the table holding the table version. Usefull if the proxy is sharing a database within a project and during upgrades. Default value is "version".+Set the name of the table holding the table version. Useful if the proxy is sharing a database within a project and during upgrades. Default value is "version".
  
 Example of usage: Example of usage:
Line 1738: Line 1739:
 Can be 'yes' or 'no'. If set to 'no', the search list in '/etc/resolv.conf' will be ignored (=> fewer lookups => gives up faster). Default value is 'yes'. Can be 'yes' or 'no'. If set to 'no', the search list in '/etc/resolv.conf' will be ignored (=> fewer lookups => gives up faster). Default value is 'yes'.
  
-HINT: even if you don't have a search list defined, setting this option to 'no' will still be "faster", because an empty search list is in fact search "" (so even if the search list is empty/missing there will still be 2 dns queries, eg. foo+'.' and  oo+""+'.')+HINT: even if you don't have a search list defined, setting this option to 'no' will still be "faster", because an empty search list is in fact search "" (so even if the search list is empty/missing there will still be 2 dns queries, eg. foo+'.' and foo+""+'.')
  
 Example of usage: Example of usage:
Line 1746: Line 1747:
 ==== use_dns_cache ==== ==== use_dns_cache ====
  
-Tells if DNS responses are cached - this means that the internal DNS resolver (instead of the system's stub resolver) will be used.  If set to "off", disables caching of DNS responses and, as side effect, DNS failover. Default is "on". Settings can be changed also during runtime (switch from niternal to system resolver and back).+Tells if DNS responses are cached - this means that the internal DNS resolver (instead of the system's stub resolver) will be used.  If set to "off", disables caching of DNS responses and, as side effect, DNS failover. Default is "on". Settings can be changed also during runtime (switch from internal to system resolver and back).
  
 ==== use_dns_failover ==== ==== use_dns_failover ====
Line 1836: Line 1837:
 ==== tcp_conn_wq_max ==== ==== tcp_conn_wq_max ====
  
-Maximum bytes queued for write allowed per connection. Attempting to queue more bytes would result in an error and in the connection being closed (too slow). If tcp_write_buf is not enabled, it has no effect.+Maximum bytes queued for write allowed per connection. Attempting to queue more bytes would result in an error and in the connection being closed (too slow). If tcp_buf_write is not enabled, it has no effect.
  
   tcp_conn_wq_max = bytes (default 32 K)   tcp_conn_wq_max = bytes (default 32 K)
Line 1897: Line 1898:
 ==== tcp_max_connections ==== ==== tcp_max_connections ====
  
-Maximum number of tcp connections (if the number is exceeded no new tcp connections will be accepted). Default is defined in tcp_conn.h: #define DEFAULT_TCP_MAX_CONNECTIONS 2048+Maximum number of tcp connections (if the number is exceeded no new tcp connections will be accepted). Default is defined in tcp_init.h: #define DEFAULT_TCP_MAX_CONNECTIONS 2048
  
 Example of usage: Example of usage:
Line 1955: Line 1956:
 ==== tcp_wq_max ==== ==== tcp_wq_max ====
  
-Maximum bytes queued for write allowed globally. It has no effect if tcp_write_buf is not enabled.+Maximum bytes queued for write allowed globally. It has no effect if tcp_buf_write is not enabled.
  
   tcp_wq_max = bytes (default 10 Mb)   tcp_wq_max = bytes (default 10 Mb)
Line 2373: Line 2374:
  
 adds a tcp port alias for the current connection (if tcp). adds a tcp port alias for the current connection (if tcp).
-Usefull if you want to send all the trafic to port_alias through+Useful if you want to send all the trafic to port_alias through
 the same connection this request came from [it could help  the same connection this request came from [it could help 
 for firewall or nat traversal]. for firewall or nat traversal].
Line 2716: Line 2717:
 ===== Custom Global Parameters ===== ===== Custom Global Parameters =====
  
-These are parameters that can be defined by the writer of kamailio.cfg in order to be used inside routing blocks. One of the important properties for custom global parameters is that their value can be changed at runtime via RPC commands, without restarting Kamailio.+These are parameters that can be defined by the writer of kamailio.cfg in order to be used inside routing blocks. One of the important properties for custom global parameters is that their value can be changed at runtime via RPC commands, without restarting Kamailio. See cfg_rpc module for RPC details.
  
 The definition of a custom global parameter must follow the pattern: The definition of a custom global parameter must follow the pattern:
Line 2950: Line 2951:
 The route is executed in when a SIP request is sent out. Only a limited number of commands are allowed (drop, if + all the checks, msg flag manipulations, send(), log(), textops::search()). The route is executed in when a SIP request is sent out. Only a limited number of commands are allowed (drop, if + all the checks, msg flag manipulations, send(), log(), textops::search()).
  
-In this route the final destination of the message is available an can be checked (with snd_ip, snd_port, to_ip, to_port, snd_proto, snd_af).+In this route the final destination of the message is available and can be checked (with snd_ip, snd_port, to_ip, to_port, snd_proto, snd_af).
  
 This route is executed only when forwarding requests - it is not executed for replies, retransmissions, or locally generated messages (e.g. via fifo uac). This route is executed only when forwarding requests - it is not executed for replies, retransmissions, or locally generated messages (e.g. via fifo uac).
cookbooks/5.0.x/core.txt · Last modified: 2019/03/12 09:55 by mslehto