Differences

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

--- cookbooks:devel:pseudovariables [2018/07/20 18:03]
miconda [$hdr(name) - Headers]
+++ cookbooks:devel:pseudovariables [2019/10/30 21:59]
127.0.0.1 external edit
@@ Line 1: / Line 1: @@
 {{ :cookbooks:devel:pseudovariables.png?200|}}
-====== Kamailio SIP Server v5.2.x (devel): Pseudo-Variables ======
+====== Kamailio SIP Server v5.4.x (devel): Pseudo-Variables ======
 ===== Introduction =====
@@ Line 76: / Line 76: @@
 **$aU** - whole username from Authorization or Proxy-Authorization header
-==== $Au - Acc username ====
+==== $Au - Acc username and realm/domain ====
-**$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns auth username ($au) if exists or From username ($fU) otherwise.
+**$Au** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns the auth username and realm ($au@$ar) if exists or From URI ($fu) otherwise.
+==== $AU - Acc username ====
+**$AU** - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns the auth username ($au) if exists or From user ($fU) otherwise.
 ==== $branch(name) - Branch attributes ====
@@ Line 225: / Line 227: @@
 If loose_route() returns TRUE a destination uri is set according to the first Route header.
-$du is also set if lookup() function of 'registrar' module finds contact(s) behind NAT. You can
+$du is also set if lookup() function of 'registrar' module finds contact(s) behind NAT or
-set $du to any SIP URI.
+if you use the path functionality. The function handle_ruri_alias() from the nathelper
+module will also set it. You can set $du to any SIP URI.
    sip:kamailio.org
    sip:pbx123.kamailio.org;transport=udp
@@ Line 278: / Line 281: @@
 **$mb** - reference to SIP message buffer
+==== $mbu - updated SIP message buffer ====
+**$mbu** - reference to updated SIP message buffer, after applying changes
 ==== $mf - Flags ====
@@ Line 915: / Line 922: @@
 }
 </code>
-===== Send Address Attributes =====
+===== Received Data Attributes =====
+==== $rcv(key) ====
+Attributes of received data. The variables must be used inside **event_route[core:msg-received]** routing block.
+The key can be:
+  * buf - received message
+  * len - lenght of received message
+  * srcip - source ip
+  * rcvip - local ip where it was received
+  * scrport - source port
+  * rcvport - local port where it was received
+  * proto - protocol as int id
+  * sproto - protocol as string
+  * af - address family
+Example of usage:
+<code c>
+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");
+}
+</code>
+===== Send Data Attributes =====
 ==== $sndfrom(name) ====
@@ Line 934: / Line 967: @@
   * af - address family to be used to send (numeric)
   * port - port of destination address
-  * proto - transport protocol to be used to send (numeric)
+  * proto - transport protocol to be used to send (numeric - UDP=1, TCP=2, TLS=3, SCTP=4, WS=5, WSS=6)
   * sproto - transport protocol to be used to send (string)
   * buf - entire send buffer as string
@@ Line 1490: / Line 1523: @@
 ==== $TV(name) ====
-Seconds and microseconds taken from struct timeval.
+Seconds and microseconds taken from struct timeval. The time at that moment is represented by **seconds.microseconds**.
   * $TV(s) - seconds (cached at first call per sip message)
   * $TV(u) - microseconds (cached at first call per sip message)
-  * $TV(sn) - seconds (not cached)
+  * $TV(sn) - seconds (not cached, taken at that moment)
-  * $TV(un) - microseconds (not cached)
+  * $TV(un) - microseconds (corresponding to the moment $TV(sn) is retrieved)
-  * $TV(Sn) - string representation seconds.microseconds (not cached)
+  * $TV(Sn) - string representation seconds.microseconds (not cached, taken at that moment)
 ===== Next hop address =====
@@ Line 1510: / Line 1542: @@
   * $nh(P) - transport protocol (upper case p)
-===== GeoIP module Pseudo-Variables =====
+===== NDB_REDIS Module =====
+==== $redis(res=>key) ====
+Access the attributes of the Redis response.
+The key can be:
+  * type - type of the reply (as in hiredis.h)
+  * value - the value returned by REDIS server;
+  * info - in case of error from REDIS, it will contain an info message.
+If reply type is an array (as in hiredis.h), there are other keys available:
+  * size - returns number of elements in the array.
+  * type[n] - returns the type of the nth element in the array. type - returns array type.
+  * value[n] - returns value of the nth element. value - returns null for an array. You need to get each element by index.
+In case one of the members of the array is also an array (for example calling SMEMBERS in a MULTI/EXEC transaction), the members of the array can be accessed by adding any of the above keys, after a value[n] key. The first value[n] references the element in the first array, while the next key references an element of the referenced array.
+Example:
+<code>
+redis_cmd("srvN", "GET foo", "r");
+xlog("===== result type: $redis(r=>type) * value: $redis(r=>value)\n");
+</code>
+==== $redisd(key) ====
+Return the corresponding value for various defines from hiredis library.
+The key can be:
+  * rpl_str - return REDIS_REPLY_STRING
+  * rpl_arr - return REDIS_REPLY_ARRAY
+  * rpl_int - return REDIS_REPLY_INTEGER
+  * rpl_nil - return REDIS_REPLY_NIL
+  * rpl_sts - return REDIS_REPLY_STATUS
+  * rpl_err - return REDIS_REPLY_ERROR
+$redisd(rpl_XYZ) can be compared with $redis(r=>type).
+Example:
+<code>
+redis_cmd("srvN", "GET foo", "r");
+if ($redis(r=>type) == $redisd(rpl_int)) {
+}
+</code>
+===== GeoIP Module =====
 ==== $gip(pvc=>key) ====
@@ Line 1615: / Line 1699: @@
 ==== $tls_peer_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type.
+==== $tls_peer_subject_uid ====
+UID in the subject section of the certificate. String type.
 ==== $tls_peer_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type.
 ==== $tls_my_subject_unit ====
 organizationalUnitName in the subject section of the certificate. String type.
+==== $tls_my_subject_uid ====
+UID in the subject section of the certificate. String type.
 ==== $tls_my_issuer_unit ====
 organizationalUnitName in the issuer section of the certificate. String type.
@@ Line 2011: / Line 2099: @@
 }
 </code>
+===== sdpops module variables =====
+  * $sdp(body) - full SDP body (read only)
+  * $sdp(sess_version) - sess-version -attribute from SDP o= -line. When set to special value -1, current value is incremented. (read + write)
+===== $sruid - Unique ID =====
+  * $sruid - return unique ID generated internally Kamailio
+===== $ltt(key) - Local To-Tag =====
+$ltt(key) - return local generated To-tag when Kamailio sends a reply
+  * $ltt(s) - the to-tag used in stateless replies
+  * $ltt(t) - the to-tag used in transaction stateful replies (transaction has to be created at that time, eg., by t_newtran() or in a branch/failure route, otherwise it returns $null)
+  * $ltt(x) - $ltt(t) if the transaction was created already, otherwise $ltt(s)
+===== tcpops module variable =====
+$tcp(key) - return TCP connection attributes.
+The key can be:
+  * c_si - connection source ip (useful with HAProxy connections)
+  * c_sp - connection source port (useful with HAProxy connections)
+  * conid - connection id
 ===== $C(xy) - Foreground and background colors =====

Kamailio SIP Server Wiki

User Tools

Site Tools

Differences

Page Tools