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
Last revision Both sides next revision
cookbooks:devel:pseudovariables [2022/03/22 17:20]
jih [$fn - From display name]
cookbooks:devel:pseudovariables [2022/04/07 10:18]
miconda [$lsock(expr)]
Line 2270: Line 2270:
  
 This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames. This class of pseudo-variables is exported by MSRP module and give access to attributes of MSRP frames.
 +
 ==== $msrp(buf) ==== ==== $msrp(buf) ====
  
 The entire content of MSRP frame - first line, headers, body and end-line. The entire content of MSRP frame - first line, headers, body and end-line.
 +
 ==== $msrp(body) ==== ==== $msrp(body) ====
  
 The body of MSRP frame. The body of MSRP frame.
 +
 ==== $msrp(code) ==== ==== $msrp(code) ====
  
 The code of MSRP replies. The code of MSRP replies.
 +
 ==== $msrp(hdrs) ==== ==== $msrp(hdrs) ====
  
 The headers in a MSRP frame. The headers in a MSRP frame.
 +
 ==== $msrp(msgid) ==== ==== $msrp(msgid) ====
  
 The body of Message-Id header. The body of Message-Id header.
 +
 ==== $msrp(method) ==== ==== $msrp(method) ====
  
 The method of a MSRP request. The method of a MSRP request.
 +
 ==== $msrp(buflen) ==== ==== $msrp(buflen) ====
  
 The length of entire MSRP frame. The length of entire MSRP frame.
 +
 ==== $msrp(sessid) ==== ==== $msrp(sessid) ====
  
 The session id for MSRP frame. It is taken from the first MSRP URI in To-Path header. The session id for MSRP frame. It is taken from the first MSRP URI in To-Path header.
 +
 ==== $msrp(reason) ==== ==== $msrp(reason) ====
  
 The reason text in a MSRP reply. The reason text in a MSRP reply.
 +
 ==== $msrp(crthop) ==== ==== $msrp(crthop) ====
  
 The URI for current hop - it is the first URI in To-Path header. The URI for current hop - it is the first URI in To-Path header.
 +
 ==== $msrp(bodylen) ==== ==== $msrp(bodylen) ====
  
Line 2307: Line 2318:
  
 The transaction ID from the first line of MSRP frame. The transaction ID from the first line of MSRP frame.
 +
 ==== $msrp(prevhop) ==== ==== $msrp(prevhop) ====
  
 The MSRP URI of the previous hop - the first address in From-Path header. The MSRP URI of the previous hop - the first address in From-Path header.
 +
 ==== $msrp(nexthop) ==== ==== $msrp(nexthop) ====
  
 The URI of the next hop - the second address in To-Path header. The URI of the next hop - the second address in To-Path header.
 +
 ==== $msrp(lasthop) ==== ==== $msrp(lasthop) ====
  
 The last hop URI - the last address in To-Path header. The last hop URI - the last address in To-Path header.
 +
 ==== $msrp(srcaddr) ==== ==== $msrp(srcaddr) ====
  
 The address of the previous hop set as MSRP URI using received source IP and port. The address of the previous hop set as MSRP URI using received source IP and port.
 +
 ==== $msrp(srcsock) ==== ==== $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) ==== ==== $msrp(firsthop) ====
  
 The URI of the first hop - the last address in From-Path header. The URI of the first hop - the last address in From-Path header.
 +
 ==== $msrp(prevhops) ==== ==== $msrp(prevhops) ====
  
 The number of previous hops - it is the number of addresses in From-Path header. The number of previous hops - it is the number of addresses in From-Path header.
 +
 ==== $msrp(nexthops) ==== ==== $msrp(nexthops) ====
  
Line 2659: Line 2678:
   * text - text of the code for the JSONRPC response   * text - text of the code for the JSONRPC response
   * body - the body of 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 ===== ===== Presence Module =====
cookbooks/devel/pseudovariables.txt · Last modified: 2022/04/11 15:24 by henningw