%docentities; ]>

This module collects the core pseudo-variables that can be used in configuration file. They are listed in Dokuwiki: http://www.kamailio.org/wiki/, in Pseudo-Variables section

The following modules must be loaded before this module: No dependencies on other &kamailio; modules.

The following libraries or applications must be installed before running &kamailio; with this module loaded: None.

Set the value of a shared variable ($shv(name)). The parameter can be set many times. The value of the parameter has the format: _name_ '=' _type_ ':' _value_ _name_: shared variable name _type_: type of the value i: integer value s: string value _value_: value to be set Default value is NULL. ... modparam("pv", "shvset", "debug=i:1") modparam("pv", "shvset", "pstngw=s:sip:10.10.10.10") ...

Set the value of a script variable ($var(name)). The parameter can be set many times. The value of the parameter has the format: _name_ '=' _type_ ':' _value_ _name_: shared variable name _type_: type of the value i: integer value s: string value _value_: value to be set Default value is NULL. ... modparam("pv", "varset", "init=i:1") modparam("pv", "varset", "gw=s:sip:11.11.11.11;transport=tcp") ...

Define aliases for PV AVP names. Default value is NULL. ... modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100") ...

Return true if a PV value is different than 'null'. Meaning of the parameters is as follows: pvar - pvar identifier. This function can be used from ANY_ROUTE. ... if(pv_isset("$avp("s:x")")) { ... } ...

Unset the value of the PV (e.g., delete AVP, set to null). Meaning of the parameters is as follows: pvar - pvar identifier. This function can be used from ANY_ROUTE. ... pv_unset("$avp("s:x")"); ...

Function checks if pvar argument contains integer value and returns 1 if it does and -1 otherwise. Function can be used from all kinds of routes. ... if (is_int("$var(foo)")) { xlog("L_INFO", "variable foo contains integer value\n"); } ...

Returns true if the type of pseudo-variable matches the second parameter. The second parameter can be: 'int' - type is integer; 'str' - type is string; 'null' - type is null. Function can be used from ANYROUTE. ... if (typeof("$var(foo)", "str")) { xdbg("variable foo is a string\n"); } ...

Returns true if the pseudo-variables has the type string and is not empty value. Function can be used from all kinds of routes. ... if (not_empty("$var(foo)")) { append_hf("X-Foo: $var(foo)\r\n"); } ...

Set the value of a shared variable ($shv(name)). Parameters: _name_: shared variable name _type_: type of the value int: integer value str: string value _value_: value to be set MI FIFO Command Format: :shv_set:_reply_fifo_file_ _name_ _type_ _value_ _empty_line_ ... $ &ctltool; fifo shv_set debug int 0 ...

Get the value of a shared variable ($shv(name)). Parameters: _name_: shared variable name. If this parameter is missing, all shared variables are returned. MI FIFO Command Format: :shv_get:_reply_fifo_file_ _name_ _empty_line_ ... $ &ctltool; fifo shv_get debug $ &ctltool; fifo shv_get ...

Set the value of a shared variable ($shv(name)). Parameters: _name_: shared variable name _type_: type of the value int: integer value str: string value _value_: value to be set

Get the value of a shared variable ($shv(name)). Parameters: _name_: shared variable name If no name is given, all shared variables are listed