Documentation

Documentation.Script-CoreVar-3-2 History

Hide minor edits - Show changes to markup

July 21, 2022, at 06:56 PM by 109.99.227.30 -
Changed line 809 from:
   $socket_out = "udp:11.11.11:5060";
to:
   $socket_out = "udp:11.11.11.11:5060";
December 20, 2021, at 12:58 PM by 109.99.227.30 -
Changed lines 62-63 from:

Script variables

to:

Script variables 🔗

Changed lines 91-92 from:

AVP variables

to:

AVP variables 🔗

Changed lines 159-160 from:

Scripting Variables

to:

Scripting Variables 🔗

Changed lines 172-173 from:

URI in SIP Request's P-Asserted-Identity header

to:

URI in SIP Request's P-Asserted-Identity header - $ai 🔗

Changed lines 178-179 from:

Authentication Digest URI

to:

Authentication Digest URI - $adu 🔗

Changed lines 184-185 from:

Authentication realm

to:

Authentication realm - $ar 🔗

Changed lines 190-191 from:

Auth username user

to:

Auth username user - $au 🔗

Changed lines 196-197 from:

Auth username domain

to:

Auth username domain - $ad 🔗

Changed lines 202-203 from:

Auth nonce

to:

Auth nonce - $an 🔗

Changed lines 207-208 from:

Auth response

to:

Auth response - $auth.resp 🔗

Changed lines 213-214 from:

Auth nonce

to:

Auth nonce - $auth.nonce 🔗

Changed lines 219-220 from:

Auth opaque

to:

Auth opaque - $auth.opaque 🔗

Changed lines 225-226 from:

Auth algorithm

to:

Auth algorithm - $auth.alg 🔗

Changed lines 231-232 from:

Auth QOP

to:

Auth QOP - $auth.qop 🔗

Changed lines 237-238 from:

Auth nonce count (nc)

to:

Auth nonce count (nc) - $auth.nc 🔗

Changed lines 243-244 from:

Auth whole username

to:

Auth whole username - $aU 🔗

Changed lines 248-249 from:

Acc username

to:

Acc username - $Au 🔗

Changed lines 253-254 from:

Argument options

to:

Argument options - $argv 🔗

Changed lines 263-264 from:

Address family (Obsoleted with OpenSIPS 3.2)

to:

Address family (Obsoleted with OpenSIPS 3.2) - $af 🔗

Changed lines 269-270 from:

Branch flags list

to:

Branch flags list - $bf 🔗

Changed lines 275-276 from:

Branch

to:

Branch - $branch 🔗

Changed lines 288-289 from:

Branch fields

to:

Branch fields - $branch.fields 🔗

Changed lines 323-324 from:

Branch flag

to:

Branch flag - $branch.flag 🔗

Changed lines 336-337 from:

Call-Id

to:

Call-Id - $ci 🔗

Changed lines 342-343 from:

Content-Length

to:

Content-Length - $cl 🔗

Changed lines 348-349 from:

CSeq number

to:

CSeq number - $cs 🔗

Changed lines 354-355 from:

Contact instance

to:

Contact instance - $ct 🔗

Changed lines 362-364 from:

Fields of a contact instance

to:

Fields of a contact instance - $ct.fields 🔗

Changed lines 380-381 from:

Content-Type

to:

Content-Type - $cT 🔗

Changed lines 390-391 from:

Domain of destination URI

to:

Domain of destination URI - $dd 🔗

Changed lines 398-399 from:

Diversion header URI

to:

Diversion header URI - $di 🔗

Changed lines 404-405 from:

Diversion "privacy" parameter

to:

Diversion "privacy" parameter - $dip 🔗

Changed lines 410-411 from:

Diversion "reason" parameter

to:

Diversion "reason" parameter - $dir 🔗

Changed lines 416-417 from:

Port of destination URI

to:

Port of destination URI - $dp 🔗

Changed lines 424-425 from:

Transport protocol of destination URI

to:

Transport protocol of destination URI - $dP 🔗

Changed lines 430-431 from:

Destination set

to:

Destination set - $ds 🔗

Changed lines 436-437 from:

Destination URI

to:

Destination URI - $du 🔗

Changed lines 445-446 from:

Error class

to:

Error class - $err.class 🔗

Changed lines 451-452 from:

Error level

to:

Error level - $err.level 🔗

Changed lines 457-458 from:

Error info

to:

Error info - $err.info 🔗

Changed lines 463-464 from:

Error reply code

to:

Error reply code - $err.rcode 🔗

Changed lines 469-470 from:

Error reply reason

to:

Error reply reason - $err.rreason 🔗

Changed lines 475-476 from:

From URI domain

to:

From URI domain - $fd 🔗

Changed lines 481-482 from:

From display name

to:

From display name - $fn 🔗

Changed lines 487-488 from:

Forced socket (Obsoleted with OpenSIPS 3.2)

to:

Forced socket (Obsoleted with OpenSIPS 3.2) - $fs 🔗

Changed lines 493-494 from:

From tag

to:

From tag - $ft 🔗

Changed lines 499-500 from:

From URI

to:

From URI - $fu 🔗

Changed lines 505-506 from:

From URI username

to:

From URI username - $fU 🔗

Changed lines 510-511 from:

OpenSIPS Log level

to:

OpenSIPS Log level - $log_level 🔗

Changed lines 536-537 from:

Message Flags

to:

Message Flags - $mf 🔗

Changed lines 542-543 from:

SIP message ID

to:

SIP message ID - $mi 🔗

Changed lines 548-549 from:

SIP message length

to:

SIP message length - $ml 🔗

Changed lines 554-555 from:

Message flag

to:

Message flag - $msg.flag 🔗

Changed lines 566-567 from:

Message is request

to:

Message is request - $msg.is_request 🔗

Changed lines 578-579 from:

Message type

to:

Message type - $msg.type 🔗

Changed lines 586-587 from:

Domain in SIP Request's original URI

to:

Domain in SIP Request's original URI - $od 🔗

Changed lines 592-593 from:

Port of SIP request's original URI

to:

Port of SIP request's original URI - $op 🔗

Changed lines 598-599 from:

Transport protocol of SIP request original URI

to:

Transport protocol of SIP request original URI - $oP 🔗

Changed lines 604-605 from:

SIP Request's original URI

to:

SIP Request's original URI - $ou 🔗

Changed lines 610-611 from:

Username in SIP Request's original URI

to:

Username in SIP Request's original URI - $oU 🔗

Changed line 616 from:

Route parameter

to:

Route parameter - $param 🔗

Changed lines 635-636 from:

Domain in SIP Request's P-Preferred-Identity header URI

to:

Domain in SIP Request's P-Preferred-Identity header URI - $pd 🔗

Changed lines 641-642 from:

Display Name in SIP Request's P-Preferred-Identity header

to:

Display Name in SIP Request's P-Preferred-Identity header - $pn 🔗

Changed lines 647-648 from:

Process id

to:

Process id - $pp 🔗

Changed lines 659-660 from:

User in SIP Request's P-Preferred-Identity header URI

to:

User in SIP Request's P-Preferred-Identity header URI - $pU 🔗

Changed lines 665-666 from:

URI in SIP Request's P-Preferred-Identity header

to:

URI in SIP Request's P-Preferred-Identity header - $pu 🔗

Changed lines 671-672 from:

Domain in SIP Request's URI

to:

Domain in SIP Request's URI - $rd 🔗

Changed lines 679-680 from:

Body of request/reply

to:

Body of request/reply - $rb 🔗

Changed lines 691-692 from:

Returned code

to:

Returned code - $rc 🔗

Changed lines 699-700 from:

Remote-Party-ID header URI

to:

Remote-Party-ID header URI - $re 🔗

Changed lines 705-706 from:

SIP request's method

to:

SIP request's method - $rm 🔗

Changed lines 711-712 from:

SIP request's port

to:

SIP request's port - $rp 🔗

Changed lines 719-720 from:

Transport protocol of SIP request URI

to:

Transport protocol of SIP request URI - $rP 🔗

Changed lines 725-726 from:

SIP reply's reason

to:

SIP reply's reason - $rr 🔗

Changed lines 731-732 from:

SIP reply's status

to:

SIP reply's status - $rs 🔗

Changed lines 737-738 from:

Refer-to URI

to:

Refer-to URI - $rt 🔗

Changed lines 743-744 from:

SIP Request's URI

to:

SIP Request's URI - $ru 🔗

Changed lines 751-752 from:

Username in SIP Request's URI

to:

Username in SIP Request's URI - $rU 🔗

Changed lines 759-760 from:

Q value of the SIP Request's URI

to:

Q value of the SIP Request's URI - $ru_q 🔗

Changed lines 767-768 from:

Received IP address (Obsoleted with OpenSIPS 3.2)

to:

Received IP address (Obsoleted with OpenSIPS 3.2) - $Ri 🔗

Changed lines 773-774 from:

Received port (Obsoleted with OpenSIPS 3.2)

to:

Received port (Obsoleted with OpenSIPS 3.2) - $Rp 🔗

Changed lines 779-780 from:

IP source address

to:

IP source address - $si 🔗

Changed lines 785-786 from:

Socket inbound

to:

Socket inbound - $socket_in 🔗

Changed lines 802-803 from:

Socket outbound

to:

Socket outbound - $socket_out 🔗

Changed lines 815-816 from:

Source port

to:

Source port - $sp 🔗

Changed lines 821-822 from:

To URI Domain

to:

To URI Domain - $td 🔗

Changed lines 827-828 from:

To display name

to:

To display name - $tn 🔗

Changed lines 833-834 from:

To tag

to:

To tag - $tt 🔗

Changed lines 839-840 from:

To URI

to:

To URI - $tu 🔗

Changed lines 845-846 from:

To URI Username

to:

To URI Username - $tU 🔗

Changed lines 851-852 from:

Formatted date and time

to:

Formatted date and time - $time 🔗

Changed lines 857-858 from:

Branch index

to:

Branch index - $T_branch_idx 🔗

Changed lines 863-864 from:

String formatted time

to:

String formatted time - $Tf 🔗

Changed lines 869-870 from:

Current unix time stamp in seconds

to:

Current unix time stamp in seconds - $Ts 🔗

Changed lines 875-876 from:

Current microseconds of the current second

to:

Current microseconds of the current second - $Tsm 🔗

Changed lines 881-882 from:

Startup unix time stamp

to:

Startup unix time stamp - $TS 🔗

Changed lines 887-888 from:

User agent header

to:

User agent header - $ua 🔗

Changed lines 893-894 from:

SIP Headers

to:

SIP Headers - $hdr 🔗

Changed line 920 from:

Route Name

to:

Route Name - $route 🔗

Changed line 999 from:

@]

to:

@]

November 25, 2020, at 02:00 PM by liviu -
Changed line 923 from:
  • $route, $(route[0]), $(route[-3]) all return: "route[B]" (current route)
to:
  • $route and $(route[0]) both return "route[B]" (current route)
Changed lines 928-929 from:
  • $(route[3]) and $(route[-4]) return NULL (index out of bounds)
to:
  • $(route[-3]) returns "route[B]" (next-next-topmost route)
  • $(route[3]) and $(route[-4]) both return NULL (index out of bounds)
November 25, 2020, at 01:59 PM by liviu -
Added line 925:
  • $(route[2]) returns "route" (previous-parent route)
November 25, 2020, at 01:53 PM by liviu -
Changed line 928 from:
  • $(route[*]) returns "route > route[A] > route[B]"
to:
  • $(route[*]) returns "route > route[A] > route[B]" (entire call stack)
November 25, 2020, at 01:52 PM by liviu -
Changed lines 921-922 from:

$route - Access route names of the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

to:

$route - Access route names of the current route call stack. Usage examples (assuming a route call stack of "route > route[A] > route[B]"):

Added line 928:
  • $(route[*]) returns "route > route[A] > route[B]"
November 25, 2020, at 01:52 PM by liviu -
Changed line 921 from:

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

to:

$route - Access route names of the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

November 25, 2020, at 01:45 PM by liviu -
Changed line 927 from:
  • $(route[3]) and $(route[-4]) return NULLL (index out of bounds)
to:
  • $(route[3]) and $(route[-4]) return NULL (index out of bounds)
November 25, 2020, at 01:44 PM by liviu -
Changed lines 921-924 from:

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> A -> B"):

  • $route, $(route[0]), $(route[-3]) all return: "B" (current route)
  • $(route[1]) returns "A" (parent route)
to:

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> route[A] -> route[B]"):

  • $route, $(route[0]), $(route[-3]) all return: "route[B]" (current route)
  • $(route[1]) returns "route[A]" (parent route)
Changed lines 926-927 from:
  • $(route[-2]) returns "A" (next-topmost route)
to:
  • $(route[-2]) returns "route[A]" (next-topmost route)
  • $(route[3]) and $(route[-4]) return NULLL (index out of bounds)
November 25, 2020, at 01:42 PM by liviu -
Changed lines 919-921 from:

Route Type

$rT - Holds the current route type as a string. Useful for determining the original route type when inside another route in script, such as a route called from an onreply_route. Allows for more generic and reusable routes such as a logging route which includes the route type in the logged message.

to:

Route Name

$route - Access the current route call stack. Usage examples (assuming a route call stack of "route -> A -> B"):

  • $route, $(route[0]), $(route[-3]) all return: "B" (current route)
  • $(route[1]) returns "A" (parent route)
  • $(route[-1]) returns "route" (topmost route)
  • $(route[-2]) returns "A" (next-topmost route)
September 03, 2020, at 11:47 AM by liviu -
Changed line 70 from:
  1. a script value can have only one value.
to:
  1. a script variable can only hold one value.
June 26, 2020, at 11:53 AM by liviu -
Changed line 269 from:

Branch flags mask

to:

Branch flags list

May 18, 2020, at 11:09 PM by 109.98.32.84 -
Added lines 564-583:

Message is request

$msg.is_request - this variable tells if the current SIP message is a request or not. The returned values are 1/"true" (request) and 0/"false" (reply).

  xlog("---- this message is a request:  $msg.is_request \n");
  if ( $msg.is_request )
    xlog("---- yes, it is a request\n");

Message type

$msg.type - this variable returns the type of the current message. The returned values are "request" (request) or "reply" (reply).

  xlog("---- this message is a SIP $msg.type \n");
May 13, 2020, at 12:13 AM by 109.98.32.84 -
Changed lines 269-270 from:

Branch flags

to:

Branch flags mask

Changed lines 325-326 from:

$branch.flag(flag_name)[] - this variable provides read/write access to the value of a certain branch flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset). An index is accepted, in order to access the flag for a certain branch. By default the 0 (or current) branch accessed (for more on index, see the the branch.fields variable) - note that "*" is not accepted.

to:

$branch.flag(flag_name)[] - this variable provides read/write access to the value of a single certain branch flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset). An index is accepted, in order to access the flag for a certain branch. By default the 0 (or current) branch accessed (for more on index, see the the branch.fields variable) - note that "*" is not accepted.

Added lines 551-562:

Message flag

$msg.flag(flag_name) - this variable provides read/write access to the value of a single certain message flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset).

  setflag("X");
  xlog("---- flag value is $msg.flag(X) \n");
  $msg.flag(X) = off;
  xlog("---- flag value is $msg.flag(X) \n");
May 13, 2020, at 12:10 AM by 109.98.32.84 -
Changed line 290 from:

$branch() - this variable provides read/write access to all fields/attributes of an already existing branch (priorly created with append_branch() ). The fields of the branch are:

to:

$branch() - this variable provides read/write access to all fields/attributes of an already existing branch (prior created with append_branch() ). The fields of the branch are:

Added lines 320-332:

Branch flag

$branch.flag(flag_name)[] - this variable provides read/write access to the value of a certain branch flag (identified by name). The values accepted for writing are 1 (set) and 0 (unset). The returned values are 1/"true" (set) and 0/"false" (unset). An index is accepted, in order to access the flag for a certain branch. By default the 0 (or current) branch accessed (for more on index, see the the branch.fields variable) - note that "*" is not accepted.

  setbflag("X");
  xlog("---- flag value is $branch.flag(X) \n");
  $branch.flag(X) = off;
  xlog("---- flag value is $branch.flag(X) \n");
April 23, 2020, at 02:12 PM by 109.98.32.84 -
Changed lines 263-266 from:

Address family

$af - The address family of the received SIP message. It's value is "INET" if the message was received over IPv4 or "INET6" if the message was received over IPv6.

to:

Address family (Obsoleted with OpenSIPS 3.2)

Use $socket_in(af) instead.

Added line 752:
  • af - the address family of the socket's IP. It's value is "INET" if IPv4 or "INET6" if IPv6.
April 23, 2020, at 01:15 PM by 109.98.32.84 -
Changed lines 475-482 from:

See $socket_out

$fs - reference to the forced socket for message sending (if any) in the form proto:ip:port

It is R/W variable (you can assign values to it routing script)

to:

Use $socket_out instead.

Changed lines 606-610 from:

Protocol of received message

$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP, WS)

to:

Protocol of received message (Obsoleted with OpenSIPS 3.2)

Use $socket_in(proto) instead.

Changed lines 721-725 from:

Received IP address

$Ri - reference to IP address of the interface where the request has been received

to:

Received IP address (Obsoleted with OpenSIPS 3.2)

Use $socket_in(ip) instead.

Changed lines 727-729 from:

Received port

$Rp - reference to the port where the message was received

to:

Received port (Obsoleted with OpenSIPS 3.2)

Use $socket_in(port) instead.

April 23, 2020, at 01:08 PM by 109.98.32.84 -
Changed line 126 from:
  1. Multilple values example
to:
  1. Multiple values example
Changed lines 159-160 from:

Pseudo Variables

to:

Scripting Variables

Added line 171:

Added lines 176-177:

Added lines 182-183:

Added lines 188-189:

Added line 195:

Added line 201:

Changed line 206 from:
to:

Added line 212:

Added line 218:

Added line 224:

Changed lines 229-230 from:
to:

Added line 236:

Added line 242:

Added line 247:

Added line 252:

Added line 262:

Added line 267:

Added lines 272-273:

Added lines 285-286:

Added lines 320-321:

Added lines 326-327:

Added lines 332-333:

Added lines 338-339:

Added lines 347-348:

Added line 365:

Changed lines 373-375 from:
to:

Added lines 382-383:

Added lines 388-389:

Added lines 394-395:

Added lines 400-401:

Added lines 408-409:

Added lines 414-415:

Added lines 420-421:

Added lines 429-430:

Added lines 435-436:

Added lines 441-442:

Added lines 447-448:

Added lines 453-454:

Added lines 459-460:

Added lines 465-466:

Added lines 471-472:

Added lines 481-483:

Added lines 488-489:

Added lines 494-495:

Added lines 521-522:

Added lines 525-526:

Added lines 531-532:

Added lines 537-538:

Added lines 543-544:

Added lines 549-550:

Added lines 555-556:

Added lines 561-562:

Added lines 567-568:

Added lines 573-574:

Added lines 592-593:

Added lines 598-599:

Added lines 604-605:

Added lines 610-611:

Added lines 615-616:

Added lines 621-622:

Added lines 627-628:

Added lines 635-636:

Added line 648:

Added lines 655-656:

Added lines 661-662:

Added lines 667-668:

Added lines 675-676:

Added lines 681-682:

Added lines 687-688:

Added lines 693-694:

Added lines 699-700:

Added lines 707-708:

Added lines 715-716:

Added lines 723-724:

Added lines 729-730:

Added lines 735-736:

Added lines 741-742:

Added line 758:

Added line 771:

Added lines 776-777:

Added lines 782-783:

Added lines 788-789:

Added lines 794-795:

Added lines 800-801:

Added lines 806-807:

Added lines 812-813:

Added lines 818-819:

Added lines 824-825:

Added lines 830-831:

Added lines 836-837:

Added lines 842-843:

Added lines 848-849:

Added lines 875-876:

Added lines 880-882:

Added line 888:

April 23, 2020, at 12:49 PM by 109.98.32.84 -
Changed line 622 from:

$socket_out - read-write variable for reading or changing the outbound socket of the message. Originally (before being written/changed) it will return the same socket description as $socket_in (the inbound socket will be used as outbound socket also).

to:

$socket_out - read-write variable for reading or changing the outbound socket of the message. Originally (before being written/changed) it will return the same socket description as $socket_in (the inbound socket will be used as outbound socket also).

Changed lines 624-629 from:

The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_out(). It provides the same sub-fields as the $socket_in variable.

to:

The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_out()'''. It provides the same sub-fields as the $socket_in variable.

   $socket_out = "udp:11.11.11:5060";
   xlog("The outbound port is $socket_out(port)\n");
April 23, 2020, at 12:45 PM by 109.98.32.84 -
Added lines 604-625:

Socket inbound

$socket_in - read-only variable to get the description (proto:ip:port format) of the inbound socket (used for receiving the message).
The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_in(). The sub-fields of the socket are:

  • ip - the IP part of the socket
  • port - the port part of the socket
  • proto - the name of the protocol of the socket (as "UDP", "TPC", etc)
  • advertised_ip - the advertised IP part of the socket (it may be NULL if no advertising is done on this particlar socket)
  • advertised_port - the advertised part part of the socket (it may be NULL if no advertising is done on this particlar socket)
  • tag - the socket internal tag/alias
  • anycast - if the socket uses an anycast IP or not (returns 0 if not, 1 if yes)

For more details on the meaning of these sub-fields, please also read about the socket definition.

Socket outbound

$socket_out - read-write variable for reading or changing the outbound socket of the message. Originally (before being written/changed) it will return the same socket description as $socket_in (the inbound socket will be used as outbound socket also).
The variable also offers detailed read-only access to various attributes/sub-fields of the socket, as $socket_out(). It provides the same sub-fields as the $socket_in variable.

April 23, 2020, at 12:28 PM by 109.98.32.84 -
Changed lines 407-408 from:

Forced socket

to:

Forced socket (Obsoleted with OpenSIPS 3.2)

See $socket_out

Deleted lines 599-602:

Script flags (Removed in OpenSIPS 3.2)

$sf - displays a list with the script flags set for the current SIP request

March 08, 2019, at 09:03 PM by 109.99.227.30 -
Changed lines 691-692 from:

Log level in xlog

$xlog_level - holds the string expansion of the log level of the xlog message

to:

Log level for xlog()

$xlog_level - allows to set /reset the xlog() logging level on per-process bases. Shortly said, you can read the verbosity level for the xlog() calls or you can temporary change the level per process bases.

Changed lines 699-704 from:

xlog("$xlog_level some text\n")

to:

xlog("current verbosity is $xlog_level \n"); $xlog_level = L_DBG; # force local xlogging limit to DBG ... (set of xlogs) ... $xlog_level = NULL; # reset to initial value

Changed lines 706-709 from:

will generate:

ERROR: some text
to:
May 15, 2018, at 07:11 PM by rvlad_patrascu -
Added lines 664-665:

$(hdr_name[N]) - returns the name of the N-th header. The first header name is obtained for N=0, the second for N=1, a.s.o. To print the last header name use -1, the second last -2 a.s.o. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all header names are printed.

July 14, 2017, at 06:03 PM by rvlad_patrascu -
Changed line 13 from:

(:toc-float Table of Content:)

to:

(:toc-float Table of Contents:)

July 14, 2017, at 12:53 PM by rvlad_patrascu -
Changed line 234 from:

$af - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

to:

$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

July 13, 2017, at 07:38 PM by rvlad_patrascu -
Changed lines 234-235 from:

$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

to:

$af - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

Added lines 244-247:

Address family

$af - The address family of the received SIP message. It's value is "INET" if the message was received over IPv4 or "INET6" if the message was received over IPv6.

January 19, 2017, at 12:39 PM by 136.243.23.236 -
Changed lines 524-525 from:

$rb - reference to message body

  • $rb - the whole body of the message
to:

$rb - reference to the body or a body part of the SIP message

  • $rb - the whole body of the message (with all the parts)
Added lines 529-530:
  • $rb(application/sdp) - get the first SDP body part
  • $(rb(application/isup)[-1]) - get the last ISUP body part
October 13, 2016, at 01:21 PM by 109.99.227.30 -
Changed lines 51-52 from:

AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).

to:

AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
A special index append is defined to allow you to add a new value at the end of the list (at the bottom of the stack) - $(avp(name)[append]) = "last value";

June 23, 2016, at 06:45 PM by rvlad_patrascu - add $xlog_level
Added lines 681-691:

Log level in xlog

$xlog_level - holds the string expansion of the log level of the xlog message Example:

xlog("$xlog_level some text\n")

will generate:

ERROR: some text
March 24, 2016, at 09:23 PM by 109.102.83.252 -
March 24, 2016, at 09:20 PM by 109.102.83.252 -
Deleted lines 247-250:

Branch flags (hexadecimal) (Removed in OpenSIPS 1.9)

$bF - reference to branch flags - hexa output

Added lines 420-438:

OpenSIPS Log level

$log_level - changes the log level for the current process ; the log level can be set to a new value (see possible values or it can be reset back to the global log level. This function is very helpful if you are tracing and debugging only a specific piece of code.

Example of usage:

    log_level= -1 # errors only
    .....
    {
      ......
      $log_level = 4; # set the debug level of the current process to DBG
      uac_replace_from(....);
      $log_level = NULL; # reset the log level of the current process to its default level
      .......
    }
Deleted lines 446-449:

Message Flags (hexadecimal) (Removed in OpenSIPS 1.9)

$mF -reference to message/transaction flags set for current SIP request in hexa

Deleted lines 594-597:

Script flags (hexadecimal) (Removed in OpenSIPS 1.9)

$sF - reference to script flags - hexa output

March 07, 2016, at 05:39 PM by liviu -
Changed lines 581-583 from:

Script flags

$sf - displays a list with the script flags set for the current SIP request

to:

Script flags (Removed in OpenSIPS 3.2)

$sf - displays a list with the script flags set for the current SIP request

November 20, 2015, at 04:54 PM by ionel_cerghit -
Changed line 672 from:

$cfg_line - Holds the current line of the action being executed, useful for logging purposes

to:

$cfg_line - Holds the current line from the script of the action being executed, useful for logging purposes \\

November 20, 2015, at 04:21 PM by ionel_cerghit - add $cfg_line $cfg_file documentation
Added lines 670-673:

Current script line and file

$cfg_line - Holds the current line of the action being executed, useful for logging purposes $cfg_file - Holds the current name of the cfg file being executed, useful when using multiple scripts via the include statement

May 19, 2015, at 04:50 PM by 89.120.101.121 -
Changed line 494 from:

$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP)

to:

$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP, WS)

March 13, 2015, at 07:12 PM by liviu -
Changed lines 333-337 from:

$cT - reference to body of content-type header and also the content-type headers inside a multi-part body

  • $cT - the main content-type of the message; the one inside the headers
  • $(cT[n]) - the n-th content-type inside a multi-part body from the beginning of message, starting with index 0
  • $(cT[-n]) - the n-th content-type inside a multi-part body from the end of the message, starting with index -1 (the last contact instance)
  • $(cT[*]) - all the content-type headears including the main one and the ones from the multi-part body
to:

$cT - reference to body of Content-Type header and also the content-type headers inside a multi-part body

  • $cT - the main Content-Type of the message; the one inside the headers
  • $(cT[n]) - the n-th Content-Type inside a multi-part body from the beginning of message, starting with index 0
  • $(cT[-n]) - the n-th Content-Type inside a multi-part body from the end of the message, starting with index -1 (the last contact instance)
  • $(cT[*]) - all the Content-Type headers including the main one and the ones from the multi-part body
March 08, 2015, at 03:22 PM by liviu -
Changed line 708 from:
    xlog("$C(bg)$avp(tmp)$C(xx) [$avp(tmp)] $C(br)$cseq$C(xx)=[$hdr(cseq)]\n");
to:
    xlog("$C(bg)$avp(tmp)$C(xx) [$avp(tmp)] $C(br)$cs$C(xx)=[$hdr(cseq)]\n");
March 05, 2015, at 02:24 PM by liviu -
Changed line 708 from:
    xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n");
to:
    xlog("$C(bg)$avp(tmp)$C(xx) [$avp(tmp)] $C(br)$cseq$C(xx)=[$hdr(cseq)]\n");
November 28, 2014, at 05:19 PM by ionutionita92 -
Changed lines 333-334 from:

$cT - reference to body of content-type header

to:

$cT - reference to body of content-type header and also the content-type headers inside a multi-part body

  • $cT - the main content-type of the message; the one inside the headers
  • $(cT[n]) - the n-th content-type inside a multi-part body from the beginning of message, starting with index 0
  • $(cT[-n]) - the n-th content-type inside a multi-part body from the end of the message, starting with index -1 (the last contact instance)
  • $(cT[*]) - all the content-type headears including the main one and the ones from the multi-part body
Added lines 513-517:
  • $rb - the whole body of the message
  • $(rb[*]) - same as $rb
  • $(rb[n]) - the n-th body belonging to a multi-part body from the beginning of message, starting with index 0
  • $(rb[-n]) - the n-th body belonging to a multi-part body from the end of the message, starting with index -1 (the last contact instance)
September 01, 2014, at 12:26 PM by 89.120.101.121 -
Added lines 658-660:

Route Type

$rT - Holds the current route type as a string. Useful for determining the original route type when inside another route in script, such as a route called from an onreply_route. Allows for more generic and reusable routes such as a logging route which includes the route type in the logged message.

March 20, 2014, at 08:33 PM by razvancrainea -
Added lines 1-700:
Documentation -> Manuals -> Manual 3.2 -> Core Variables

(:title Core Variables - 3.2:)


(:allVersions Script-CoreVar 3.2:)


Core Variables v3.2
PrevNext

(:toc-float Table of Content:)

OpenSIPS provides multiple type of variables to be used in the routing script. The difference between the types of variables comes from (1) the visibility of the variable (when it is visible), (2) what the variable is attached to (where the variable resides), (3) read-write status of the variable (some types of the variables are read-only and (4) how multiple values (for the same variable are handled).

The OpenSIPS variables can be easily identified in the script as all their names (or notations) start with the $ sign.

Syntax:
The complete syntax for a pseudo variable is:

$(<context>name(subname)[index]{transformation})

The fields written in green are optional. The fields meaning is:

  • name(compulsory) - the pseudo-variable name(type).
    Ex: pvar, avp, ru, DLG_status, etc.
  • subname - the identifier of a certain pv from the given type.
    Ex: hdr(From), avp(name).
  • index - a pv can store more than one value - it can refer to a list of values. You can access a certain value from the list if you specify its index. You can also specify indexes with negative values, -1 means the last inserted, -2 the value before the previous inserted one.
  • transformation - a series of processing actions can be applied on pseudo-variable. You can find the whole list of possible transformations here. The transformations can be cascaded, using the output of one transformation as the input of another.
  • context - the context in which the pseudo0variable will be evaluated. Now there are 2 pv contexts: reply and request. The reply context can be used in the failure route to request for the pseudo-variable to be evaluated in the context of the reply message. The request context can be used if in a reply route is desired for the pv to be evaluated in the context of the corresponding request.

Usage examples:

  • Only name: $ru
  • Name and 'subname: $hdr(Contact)
  • Name and index: $(ct[0])
  • Name, subname and index: $(avp(i:10)[2])
  • Context
    • $(<request>ru) from a reply route will get the Request-URI from the request
    • $(<reply>hdr(Contact)) context can be used from failure route to access information from the reply

Types of variables:

  • script variables - as the name says, these variables are strictly bound to the script routes. The variables are visible only in the routing blocks - they are not message or transaction related, but they are process related (script variables will be inherited by script routes executed by the same OpenSIPS process).
    Script variables are read write and they can have integer or string values. A script variable can only hold a single value. A new assignment (or write operation) will overwrite the existing value.
  • AVP - Attribute Value Pair - the AVPs are dynamic variables (as name) that can be created - the AVPS are linked to a singular message or transaction (if stateful processing is used). A message or a transaction will initially (when received or created) have an empty list of AVPS attached to it. During the routing script, the script directly or functions called from script may create new AVPS that will automatically attached to the message/transaction. The AVPS will be visible in all routes where any message (reply or request) of the transaction will be processed - branch_route , failure_route, onreply_route (for this last route you need to enable the TM parameter onreply_avp_mode).
    AVPs are read write and an existing AVP can be even deleted (removed). An AVP may contain multiple values - a new assignment (or write operation) will add a new value to the AVP; the values are kept in "last added first to be used" order (stack).
  • pseudo variables - pseudo-variables (or PV) provide access to information from the processed SIP message (headers, RURI, transport level info, a.s.o) or from OpenSIPS inners (time values, process PID, return code of a function). Depending of what info they provide, the PVs are either bound to the message, either to nothing (global). Most of the PVs are read-only and only several allow write operations. A PV may return several values or only one, depending of the referred info (if can have multiple values or not).
    Standard PV is read-only and returns a single value (if not otherwise documented).
  • escape sequences - escape sequences used to format the strings; they are actually not variables, but rather formatters.

Script variables

Naming: **$var(name)**

Hints:

  1. if you want to start using a script variable in a route, better initialize it with same value (or reset it), otherwise you may inherit a value from a previous route that was executed by the same process.
  2. script variables are faster than AVPs, as they directly reference a memory location.
  3. the value of script variables persists over a OpenSIPS process.
  4. a script value can have only one value.

Example of usage:

$var(a) = 2;  # sets the value of variable 'a' to integer '2'
$var(a) = "2";  # sets the value of variable 'a' to string '2'
$var(a) = 3 + (7&(~2)); # arithmetic and bitwise operation
$var(a) = "sip:" + $au + "@" + $fd; # compose a value from authentication username and From URI domain

# using a script variable for tests
if( [ $var(a) & 4 ] ) {
  xlog("var a has third bit set\n");
}

Setting a variable to NULL is actually initializing the value to integer '0'. Script variables don't have NULL value.

AVP variables

Naming: **$avp(name)** or **$(avp(name)[N])**

When using the index "N" you can force the AVP to return a certain value (the N-th value). If no index is given, the first value will be returned.

Hints:

  1. to enable AVPs in onreply_route, use "modparam("tm", "onreply_avp_mode", 1)"
  2. if multiple values are used for a single AVP, the values are index in revert order than added
  3. AVPs are part of the transaction context, so they will be visible everywhere where the transaction is present.
  4. the value of an AVP can be deleted

Example of usage:

  1. Transaction persistence example
# enable avps in onreply route
modparam("tm", "onreply_avp_mode", 1)
...
route{
...
$avp(tmp) = $Ts ; # store the current time (at request processing)
...
t_onreply("1");
t_relay();
...
}

onreply_route[1] {
	if (t_check_status("200")) {
		# calculate the setup time
		$var(setup_time) = $Ts - $avp(tmp);
	}
}
  1. Multilple values example
$avp(17) = "one";
# we have a single value
$avp(17) = "two";
# we have two values ("two","one")
$avp(17) = "three";
# we have three values ("three","two","one")

xlog("accessing values with no index: $avp(17)\n");
# this will print the first value, which is the last added value -> "three"

xlog("accessing values with no index: $(avp(17)[2])\n");
# this will print the index 2 value (third one), -> "one"

# remove the last value of the avp; if there is only one value, the AVP itself will be destroyed
$avp(17) = NULL;

# delete all values and destroy the AVP
avp_delete("$avp(17)/g");

# delete the value located at a certain index 
$(avp(17)[1]) = NULL;

#overwrite the value at a certain index
$(avp(17)[0]) = "zero";

The AVPOPS module provides a lot of useful functions to operate AVPs (like checking values, pushing values into different other locations, deleting AVPs, etc).

Pseudo Variables

Naming: $name

Hints:

  1. the PV tokens can be given as parameters to different script functions and they will be replaced with a value before the execution of the function.
  2. most of PVs are made available by OpenSIPS core, but there are also module exporting PV (to make available info specific to that module) - check the modules documentation.

Predefined (provided by core) PVs are listed in alphabetical order.

URI in SIP Request's P-Asserted-Identity header

$ai - reference to URI in request's P-Asserted-Identity header (see RFC 3325)

Authentication Digest URI

$adu - URI from Authorization or Proxy-Authorization header. This URI is used when calculating the HTTP Digest Response.

Authentication realm

$ar - realm from Authorization or Proxy-Authorization header

Auth username user

$au - user part of username from Authorization or Proxy-Authorization header

Auth username domain

$ad - domain part of username from Authorization or Proxy-Authorization header

Auth nonce

$an - the nonce from Authorization or Proxy-Authorization header

Auth response

$auth.resp - the authentication response from Authorization or Proxy-Authorization header

Auth nonce

$auth.nonce - the nonce string from Authorization or Proxy-Authorization header

Auth opaque

$auth.opaque - the opaque string from Authorization or Proxy-Authorization header

Auth algorithm

$auth.alg - the algorithm string from Authorization or Proxy-Authorization header

Auth QOP

$auth.qop - the value of qop parameter from Authorization or Proxy-Authorization header

Auth nonce count (nc)

$auth.nc - the value of nonce count parameter from Authorization or Proxy-Authorization header

Auth whole username

$aU - whole username from Authorization or Proxy-Authorization header

Acc username

$Au - username for accounting purposes. It's a selective pseudo variable (inherited from acc module). It returns $au if exits or From username otherwise.

Argument options

$argv - provides access to command line arguments specified with '-o' option. Examples:

   # for option '-o foo=0'
   xlog("foo is $argv(foo) \n");

Branch flags

$bf - displays a list with the branch flags set for the current SIP request

Branch flags (hexadecimal) (Removed in OpenSIPS 1.9)

$bF - reference to branch flags - hexa output

Branch

$branch - this variable is used for creating new branches by writing into it the value of a SIP URI. Examples:

   # creates a new branch
   $branch = "sip:new@doamin.org";
   # print its URI
   xlog("last added branch has URI $(branch(uri)[-1]) \n");

Branch fields

$branch() - this variable provides read/write access to all fields/attributes of an already existing branch (priorly created with append_branch() ). The fields of the branch are:

  • uri - the RURI of the branch (string value)
  • duri - destination URI of the branch (outbound proxy of the branch) (string value)
  • q - q value of the branch (int value)
  • path - the PATH string for this branch (string value)
  • flags - the branch flags of this branch (int value)
  • socket - the local socket to be used for relaying this branch (string value)

The variable accepts also index $(branch(uri)[1]) for accessing a specific branch (multiple branches can be defined at a moment). The index starts from 0 (first branch). If the index is negative, it is considered the n-th branch from the end ( index -1 means the last branch).
To get all branches, use the * index - $(branch(uri)[*]).
Examples:

   # creates the first branch
   append_branch();
   # creates the second branch
   force_send_socket(udp:193.268.1.12:5060);
   $du = "sip:193.268.3.20";
   append_branch("sip:foo@bar.com","0.5");

   # display branches
   xlog("----- branch 0: $(branch(uri)[0]) , $(branch(q)[0]), $(branch(duri)[0]), $(branch(path)[0]), $(branch(flags)[0]), $(branch(socket)[0]) \n");
   xlog("----- branch 1: $(branch(uri)[1]) , $(branch(q)[1]), $(branch(duri)[1]), $(branch(path)[1]), $(branch(flags)[1]), $(branch(socket)[1]) \n");

   # do some changes over the branches
   $branch(uri) = "sip:user@domain.ro";   # set URI for the first branch
   $(branch(q)[0]) = 1000;  # set to 1.00 for the first branch
   $(branch(socket)[1]) = NULL;  # reset the socket of the second branch
   $branch(duri) = NULL;  # reset the destination URI or the first branch

It is R/W variable (you can assign values to it from routing logic)

Call-Id

$ci - reference to body of call-id header

Content-Length

$cl - reference to body of content-length header

CSeq number

$cs - reference to cseq number from cseq header

Contact instance

$ct - reference to contact instance/body from the contact header. A contact instance is display_name + URI + contact_params. As a Contact header may contain multiple Contact instances and a message may contain multiple Contact headers, an index was added to the $ct variable:

  • $ct -first contact instance from message
  • $(ct[n]) - the n-th contact instance form the beginning of message, starting with index 0
  • $(ct[-n]) - the n-th contact instance form the end of the message, starting with index -1 (the last contact instance)

Fields of a contact instance

$ct.fields() - reference to the fields of a contact instance/body (see above). Supported fields are:

  • name - display name
  • uri - contact uri
  • q - q param (value only)
  • expires - expires param (value only)
  • methods - methods param (value only)
  • received - received param (value only)
  • params - all params (including names)

Examples:

  • $ct.fields(uri) - the URI of the first contact instance
  • $(ct.fields(name)[1]) - the display name of the second contact instance

Content-Type

$cT - reference to body of content-type header

Domain of destination URI

$dd - reference to domain of destination uri

It is R/W variable (you can assign values to it from routing logic)

Diversion header URI

$di - reference to Diversion header URI

Diversion "privacy" parameter

$dip - reference to Diversion header "privacy" parameter value

Diversion "reason" parameter

$dir - reference to Diversion header "reason" parameter value

Port of destination URI

$dp - reference to port of destination uri

It is R/W variable (you can assign values to it from routing logic)

Transport protocol of destination URI

$dP - reference to transport protocol of destination uri

Destination set

$ds - reference to destination set

Destination URI

$du - reference to destination uri (outbound proxy to be used for sending the request) If loose_route() returns TRUE a destination uri is set according to the first Route header.

It is R/W variable (you can assign values to it from routing logic)

Error class

$err.class - the class of error (now is '1' for parsing errors)

Error level

$err.level - severity level for the error

Error info

$err.info - text describing the error

Error reply code

$err.rcode - recommended reply code

Error reply reason

$err.rreason - recommended reply reason phrase

From URI domain

$fd - reference to domain in URI of 'From' header

From display name

$fn - reference to display name of 'From' header

Forced socket

$fs - reference to the forced socket for message sending (if any) in the form proto:ip:port

It is R/W variable (you can assign values to it routing script)

From tag

$ft - reference to tag parameter of 'From' header

From URI

$fu - reference to URI of 'From' header

From URI username

$fU - reference to username in URI of 'From' header

SIP message buffer

$mb - reference to SIP message buffer

Message Flags

$mf - displays a list with the message/transaction flags set for the current SIP request

Message Flags (hexadecimal) (Removed in OpenSIPS 1.9)

$mF -reference to message/transaction flags set for current SIP request in hexa

SIP message ID

$mi - reference to SIP message id

SIP message length

$ml - reference to SIP message length

Domain in SIP Request's original URI

$od - reference to domain in request's original R-URI

Port of SIP request's original URI

$op - reference to port of original R-URI

Transport protocol of SIP request original URI

$oP - reference to transport protocol of original R-URI

SIP Request's original URI

$ou - reference to request's original URI

Username in SIP Request's original URI

$oU - reference to username in request's original URI

Route parameter

$param(idx) - retrieves the parameters of the route. The index can be an integer, or a pseudo-variable (index starts at 1).
Example:

   route {
      ...
      $var(debug) = "DBUG:"
      route(PRINT_VAR, $var(debug), "param value");
      ...
   }

   route[PRINT_VAR] {
      $var(index) = 2;
      xlog("$param(1): The parameter value is <$param($var(index))>\n");
   }

Domain in SIP Request's P-Preferred-Identity header URI

$pd - reference to domain in request's P-Preferred-Identity header URI (see RFC 3325)

Display Name in SIP Request's P-Preferred-Identity header

$pn - reference to Display Name in request's P-Preferred-Identity header (see RFC 3325)

Process id

$pp - reference to process id (pid)

Protocol of received message

$pr or $proto - protocol of received message (UDP, TCP, TLS, SCTP)

User in SIP Request's P-Preferred-Identity header URI

$pU - reference to user in request's P-Preferred-Identity header URI (see RFC 3325)

URI in SIP Request's P-Preferred-Identity header

$pu - reference to URI in request's P-Preferred-Identity header (see RFC 3325)

Domain in SIP Request's URI

$rd - reference to domain in request's URI

It is R/W variable (you can assign values to it routing script)

Body of request/reply

$rb - reference to message body

Returned code

$rc - reference to returned code by last invoked function

$retcode - same as **$rc**

Remote-Party-ID header URI

$re - reference to Remote-Party-ID header URI

SIP request's method

$rm - reference to request's method

SIP request's port

$rp - reference to port of R-URI

It is R/W variable (you can assign values to it routing script)

Transport protocol of SIP request URI

$rP - reference to transport protocol of R-URI

SIP reply's reason

$rr - reference to reply's reason

SIP reply's status

$rs - reference to reply's status

Refer-to URI

$rt - reference to URI of refer-to header

SIP Request's URI

$ru - reference to request's URI

It is R/W variable (you can assign values to it routing script)

Username in SIP Request's URI

$rU - reference to username in request's URI

It is R/W variable (you can assign values to it routing script)

Q value of the SIP Request's URI

$ru_q - reference to q value of the R-URI

It is R/W variable (you can assign values to it routing script)

Received IP address

$Ri - reference to IP address of the interface where the request has been received

Received port

$Rp - reference to the port where the message was received

Script flags

$sf - displays a list with the script flags set for the current SIP request

Script flags (hexadecimal) (Removed in OpenSIPS 1.9)

$sF - reference to script flags - hexa output

IP source address

$si - reference to IP source address of the message

Source port

$sp - reference to the source port of the message

To URI Domain

$td - reference to domain in URI of 'To' header

To display name

$tn - reference to display name of 'To' header

To tag

$tt - reference to tag parameter of 'To' header

To URI

$tu - reference to URI of 'To' header

To URI Username

$tU - reference to username in URI of 'To' header

Formatted date and time

$time(format) - returns the string formatted time according to UNIX date (see: man date).

Branch index

$T_branch_idx - the index (starting with 1 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'. This is exported by TM module.

String formatted time

$Tf - reference string formatted time

Current unix time stamp in seconds

$Ts - reference to current unix time stamp in seconds

Current microseconds of the current second

$Tsm - reference to current microseconds of the current second

Startup unix time stamp

$TS - reference to startup unix time stamp

User agent header

$ua - reference to user agent header field

SIP Headers

$(hdr(name)[N]) - represents the body of the N-th header identified by 'name'. If [N] is omitted then the body of the first header is printed. The first header is got when N=0, for the second N=1, a.s.o. To print the last header of that type, use -1, no other negative values are supported now. No white spaces are allowed inside the specifier (before }, before or after {, [, ] symbols). When N='*', all headers of that type are printed.

The module should identify most of compact header names (the ones recognized by OpenSIPS which should be all at this moment), if not, the compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster.

$(hdrcnt(name)) -- returns number of headers of type given by 'name'. Uses same rules for specifying header names as $hdr(name) above. Many headers (e.g., Via, Path, Record-Route) may appear more than once in the message. This variable returns the number of headers of a given type.

Note that some headers (e.g., Path) may be joined together with commas and appear as a single header line. This variable counts the number of header lines, not header values.

For message fragment below, $hdrcnt(Path) will have value 2 and $(hdr(Path)[0]) will have value <a.com>:

    Path: <a.com>
    Path: <b.com>

For message fragment below, $hdrcnt(Path) will have value 1 and $(hdr(Path)[0]) will have value <a.com>,<b.com>:

    Path: <a.com>,<b.com>

Note that both examples above are semantically equivalent but the variables take on different values.

Escape Sequences

These sequences are exported, and mainly used, by xlog module to print messages in many colors (foreground and background) using escape sequences.

Foreground and background colors

$C(xy) - reference to an escape sequence. ¿x¿ represents the foreground color and ¿y¿ represents the background color.

Colors could be:

  • x : default color of the terminal
  • s : Black
  • r : Red
  • g : Green
  • y : Yellow
  • b : Blue
  • p : Purple
  • c : Cyan
  • w : White

Examples

A few examples of usage.

...
route {
...
    $avp(uuid)="caller_id";
    $avp(tmp)= $avp(uuid) + ": " + $fu;
    xdbg("$(C(bg))avp(tmp)$(C(xx)) [$avp(tmp)] $(C(br))cseq$(C(xx))=[$hdr(cseq)]\n");
...
}
...

Page last modified on July 21, 2022, at 06:56 PM