$Revision: 1036 $
$Date: 2006-07-19 11:05:15 +0300 (Wed, 19 Jul 2006) $
User's Guide
Overview
Various checks related to &sip; &uri;.
Dependencies
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
None.
Exported Functions
<function moreinfo="none">is_user(username)</function>
Check if the username in credentials matches the given username.
Meaning of the parameters is as follows:
username - Username string.
This function can be used from REQUEST_ROUTE.
<function>is_user</function> usage
...
if (is_user("john")) {
...
};
...
<function moreinfo="none">has_totag()</function>
Check if To header field uri contains tag parameter.
This function can be used from REQUEST_ROUTE.
<function>has_totag</function> usage
...
if (has_totag()) {
...
};
...
<function moreinfo="none">uri_param(param)</function>
Find if Request URI has a given parameter with no value
Meaning of the parameters is as follows:
param - parameter name to look for.
This function can be used from REQUEST_ROUTE.
<function>uri_param</function> usage
...
if (uri_param("param1")) {
...
};
...
<function moreinfo="none">uri_param(param,value)</function>
Find if Request URI has a given parameter with matching value
Meaning of the parameters is as follows:
param - parameter name to look for.
value - parameter value to match.
This function can be used from REQUEST_ROUTE.
<function>uri_param</function> usage
...
if (uri_param("param1","value1")) {
...
};
...
<function moreinfo="none">add_uri_param(param)</function>
Add to RURI a parameter (name=value);
Meaning of the parameters is as follows:
param - parameter to be appended in
name=value
format.
This function can be used from REQUEST_ROUTE.
<function>add_uri_param</function> usage
...
add_uri_param("nat=yes");
...
<function moreinfo="none">tel2sip()</function>
Converts RURI, if it is tel URI, to SIP URI. Returns true, only if
conversion succeeded or if no conversion was needed (like RURI
was not tel URI.
This function can be used from REQUEST_ROUTE.
<function>tel2sip</function> usage
...
tel2sip();
...
<function moreinfo="none">is_uri_user_e164(pseudo-variable)</function>
Checks if userpart of URI stored in pseudo variable is
E164 number.
This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
<function>is_uri_user_e164</function> usage
...
if (is_uri_user_e164("$fu")) { # Check From header URI user part
...
}
if (is_uri_user_e164("$avp(i:705)") {
# Check user part of URI stored in avp i:705
...
};
...