Differences

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

--- cookbooks:devel:pseudovariables [2022/03/22 16:16] – [$td - To URI Domain] jih
+++ cookbooks:devel:pseudovariables [2022/04/11 13:24] (current) – geoip2 henningw
@@ Line 285: / Line 285: @@
 **$fd** - reference to domain in URI of 'From' header
-<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $fn - From display name ====
 **$fn** - reference to display name of 'From' header
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $fs - Forced Send Socket ====
@@ Line 333: / Line 335: @@
 **$fu** - reference to URI of 'From' header
-<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
@@ Line 341: / Line 343: @@
 **$fU** - reference to username in URI of 'From' header
-<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file)</fc>
+<fc #0000ff>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 Note that changing the From: header may break backwards compatibility with SIP 1.0 devices.
@@ Line 680: / Line 682: @@
 **$tn** - reference to display name of 'To' header
+<fc #0000FF>It is R/W variable (you can assign values to it directly in configuration file, but its value does not change)</fc>
 ==== $tt - To tag ====
@@ Line 2077: / Line 2081: @@
 if($gip(src=>cc)==$gip(dst=>cc))
+{
+    # source and destination from same country
+}
+</code>
+==== $gip2(pvc=>key) ====
+Variables exported by GeoIP2 module, returning geo-location attributes. The attributes are populated upon calling function **geoip_match2(ipaddr, pvc)**.
+**pvc** (container id) is second parameter of geoip_match2(..) and **key** can be:
+  * cc - country code
+  * tz - time zone
+  * zip - postal code
+  * lat - latitude
+  * lon - longitude
+  * dma - dma code
+  * ips - ip start
+  * ipe - ip end
+  * city - city
+  * area - area code
+  * regc - region
+  * regn - region name
+  * metro - metro code
+  * contc - continent code
+You can call several time **geoip_match(ipaddr, pvc)** with different ip address and containers in your config, to compare, for example, attributes of source and destination of a call.
+<code c>
+geoip_match2("$si", "src");
+geoip_match2("$nh(d)", "dst");
+if($gip2(src=>cc)==$gip2(dst=>cc))
 {
     # source and destination from same country
@@ Line 2266: / Line 2304: @@
 This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames.
 ==== $msrp(buf) ====
 The entire content of MSRP frame - first line, headers, body and end-line.
 ==== $msrp(body) ====
 The body of MSRP frame.
 ==== $msrp(code) ====
 The code of MSRP replies.
 ==== $msrp(hdrs) ====
 The headers in a MSRP frame.
 ==== $msrp(msgid) ====
 The body of Message-Id header.
 ==== $msrp(method) ====
 The method of a MSRP request.
 ==== $msrp(buflen) ====
 The length of entire MSRP frame.
 ==== $msrp(sessid) ====
 The session id for MSRP frame. It is taken from the first MSRP URI in To-Path header.
 ==== $msrp(reason) ====
 The reason text in a MSRP reply.
 ==== $msrp(crthop) ====
 The URI for current hop - it is the first URI in To-Path header.
 ==== $msrp(bodylen) ====
@@ Line 2303: / Line 2352: @@
 The transaction ID from the first line of MSRP frame.
 ==== $msrp(prevhop) ====
 The MSRP URI of the previous hop - the first address in From-Path header.
 ==== $msrp(nexthop) ====
 The URI of the next hop - the second address in To-Path header.
 ==== $msrp(lasthop) ====
 The last hop URI - the last address in To-Path header.
 ==== $msrp(srcaddr) ====
 The address of the previous hop set as MSRP URI using received source IP and port.
 ==== $msrp(srcsock) ====
-The local socket where the MSRP frame was received, set as **proto:ipaddr:port".
+The local socket where the MSRP frame was received, set as **proto:ipaddr:port**.
 ==== $msrp(firsthop) ====
 The URI of the first hop - the last address in From-Path header.
 ==== $msrp(prevhops) ====
 The number of previous hops - it is the number of addresses in From-Path header.
 ==== $msrp(nexthops) ====
@@ Line 2655: / Line 2712: @@
   * text - text of the code for the JSONRPC response
   * body - the body of the JSONRPC response
+===== $lsock(expr) =====
+Get attributes for listen sockets (from corex module).
+The **expr** is an expression specifying what to match and return, the format is:
+<code>
+matchid/value/field
+</code>
+The **expr** can contain variables that are evaluated before parsing the expression.
+The **matchid** can be:
+  * n - match on name
+  * l - match on listen address
+The **value** specifies what to match with.
+The **field** can be (only first character matches):
+  * name - return name
+  * listen - return the listen address
+  * advertise - return the advertise address
+  * index - return the index in the list of all sockets
+Example:
+<code>
+listen=udp:127.0.0.1:5060 advertise 127.0.0.1:5090 name "s0"
+...
+xinfo("$lsock(n/s0/listen)\n");
+xinfo("$lsock(l/udp:127.0.0.1:5060/name)\n");
+$var(s0) = "n/s0/listen";
+xinfo("$lsock($var(s0))\n");
+</code>
+===== Evrexec Module =====
+==== $evr(key) ====
+evrexec attributes:
+  * $evr(data) - processing data
+  * $evr(srcip) - source ip
+  * $evr(srcport) - sourceport as string
+  * $evr(srcportno) - source port as number
 ===== Presence Module =====