User Tools

Site Tools


cookbooks:devel:pseudovariables

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
cookbooks:devel:pseudovariables [2020/01/22 15:43]
miconda
cookbooks:devel:pseudovariables [2020/04/02 15:23]
miconda [$fs - Forced socket]
Line 248: Line 248:
 **$fn** - reference to display name of 'From' header **$fn** - reference to display name of 'From' header
  
-==== $fs - Forced socket ====+==== $fs - Forced Send Socket ====
  
-**$fs** - reference to the forced socket for message sending (if any) in the form proto:ip:port+**$fs** - reference to the forced send socket for the SIP message (if any) in the form "proto:ip:port". It is the socket from where Kamailio is going to send out the message.
  
 <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file). Transport proto can be omitted when assigning value, in which case it is taken from destination URI of the message.</fc> <fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file). Transport proto can be omitted when assigning value, in which case it is taken from destination URI of the message.</fc>
 +
 +Example:
 +
 +<code c>
 +listen=udp:1.2.3.4:5060
 +...
 +$fs = "udp:1.2.3.4:5060";
 +</code>
 +
 +==== $fsn - Forced Send Socket Name ====
 +
 +**$fsn** - reference to the name of the forced send socket for the SIP message. The name can be assigned to this variable to select a send socket via its name.
 +
 +<code c>
 +listen=udp:1.2.3.4:5060 name "s1"
 +...
 +$fsn = "s1";
 +...
 +$fs = "udp:1.2.3.4:5060";
 +xdbg("name for forced send socket: $fsn\n");
 +</code>
  
 ==== $ft - From tag ==== ==== $ft - From tag ====
Line 639: Line 660:
 **$env(NAME)** - value of the environment variable named NAME **$env(NAME)** - value of the environment variable named NAME
  
 +Example:
 +
 +<code c>
 +xdbg("PATH environment variable:  $env(PATH)\n");
 +</code>
 ===== $avp(id) - AVPs ===== ===== $avp(id) - AVPs =====
  
Line 754: Line 780:
  
 xavps are read and write variables. You can create multilevel xavps, as xavps may contain xavps. xavps are read and write variables. You can create multilevel xavps, as xavps may contain xavps.
 +
 +===== $xavu(id) - XAVUs =====
 +
 +Similar to XAVPs, but with single value items, therefore there are no indexes in the naming format. XAVUs are also stored in transaction context and destroyed when the transaction is terminated.
 +
 +Examples:
 +
 +<code c>
 +$xavu(x) = 123; # <- set the value
 +$xavu(x) = 234; # <- update to the value, not adding to a list like for xavps
 +$xavu(x) = $null; # <- delete the xavu
 +$xavu(a=>b) = "xyz"; # <- two level naming supported
 +</code>
  
 ===== $hdr(name) - Headers ===== ===== $hdr(name) - Headers =====
cookbooks/devel/pseudovariables.txt ยท Last modified: 2022/04/11 15:24 by henningw