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 [2021/02/20 11:58]
jih
cookbooks:devel:pseudovariables [2021/05/12 13:18]
miconda [$rcv(key)]
Line 1: Line 1:
-{{ :cookbooks:devel:pseudovariables.png?200|}} 
 ====== Pseudo-Variables ====== ====== Pseudo-Variables ======
  
-Version: Kamailio SIP Server v5.5.x (devel)+Version: Kamailio SIP Server v5.6.x (devel) 
 + 
 +{{ :cookbooks:devel:pseudovariables.png?200|}}
  
 ===== Introduction ===== ===== Introduction =====
Line 437: Line 438:
 **$retcode** - same as **$rc** **$retcode** - same as **$rc**
  
 +Note that the value of $rc is overwritten by each new function call.
 +
 +Example of use:
 +
 +<code c>
 + lookup("location");
 + $var(rc) = $rc;
 + if ($var(rc) < 0) {
 + t_newtran();
 + switch ($var(rc)) {
 + case -1:
 + case -3:
 + send_reply("404", "Not Found");
 + exit;
 + case -2:
 + send_reply("405", "Method Not Allowed");
 + exit;
 + }
 + }
 +
 +</code>
 ==== $rd - Domain in R-URI ==== ==== $rd - Domain in R-URI ====
  
Line 1074: Line 1096:
 event_route[core:msg-received] { event_route[core:msg-received] {
   xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n");   xlog("rcv on $rcv(af)/$rcv(proto): ($rcv(len)) [$rcv(buf)] from [$rcv(srcip):$rcv(srcport)] to [$rcv(rcvip):$rcv(rcvport)]\n");
 +}
 +</code>
 +
 +==== $rpl(key) ====
 +
 +Attributes of the SIP reply processed at that moment. The variables must be used during SIP reply processing, otherwise it returns $null.
 +
 +The key can be:
 +
 +  * duri - SIP URI corresponding to the address where the SIP reply is going to be sent based on 2nd via
 +  * dhost - host part of duri
 +  * dport - port part of duri
 +  * dproto - proto part of duri
 +  * dprotoid - proto id of duri
 +  * cntvia - the number of Via header bodies
 +
 +Example of usage:
 +
 +<code c>
 +reply_route{
 +  xinfo("reply to be sent to: $rpl(duri)\n");
 } }
 </code> </code>
Line 1584: Line 1627:
 ==== $T_branch_idx ==== ==== $T_branch_idx ====
  
-  * the index (starting with for the first branch) of the branch for which is executed the branch_route[]. If used outside of branch_route[] block, the value is '0'.+  * the index (starting with for the first branch) of the branch for which is executed the branch_route[]. 
 +  * in failure_route[] block, the value is the number of completed branches added to the number of new new branches 
 +  * in request_route block, the value is number of created branches 
 +  * in onreply_route[], the value is the index of the branch receiving the reply 
 +  * if used outside of transaction processing, the value is '-1'
  
 ==== $T_reply_ruid ==== ==== $T_reply_ruid ====
cookbooks/devel/pseudovariables.txt · Last modified: 2022/04/11 15:24 by henningw