$Revision: 1.1.10.1 $
$Date: 2005/06/22 23:12:08 $
User's Guide
Overview
The module contains record routing logic
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>enable_full_lr</varname> (integer)
If set to 1 then ;lr=on instead of just ;lr will be used. This is to overcome
problems with broken &ua;s which strip ;lr parameter when generating Route header
fields from Record-Route (;lr=on seems to help).
Default value is 0 (no).
Set <varname>enable_full_lr</varname> parameter
...
modparam("rr", "enable_full_lr", 1)
...
<varname>append_fromtag</varname> (integer)
if turned on, request's from-tag is appended to record-route; that's useful for
understanding whether subsequent requests (such as BYE) come from caller (route's
from-tag==BYE's from-tag) or callee (route's from-tag==BYE's to-tag)
Default value is 1 (yes).
Set <varname>append_fromtag</varname> parameter
...
modparam("rr", "append_fromtag", 0)
...
<varname>enable_double_rr</varname> (integer)
There are some situations when the server needs to insert two Record-Route header
fields instead of one. For example when using two disconnected networks or doing
cross-protocol forwarding from UDP->TCP. This parameter enables inserting of 2
Record-Routes. The server will later remove both of them.
Default value is 1 (yes).
Set <varname>enable_double_rr</varname> parameter
...
modparam("rr", "enable_double_rr", 0)
...
<varname>add_username</varname> (integer)
This parameter controls whether Record-Route header fields
inserted by SER will contain the username part. When set to 0
then SER will produce Record-Route header fields without the
username part, when set to 1 then Record-Route header fields
will contain the username of the callee in the username part.
Default value is 0 (do not add username).
Set <varname>enable_double_rr</varname> parameter
...
modparam("rr", "enable_double_rr", 0)
...
Exported Functions
<function moreinfo="none">loose_route()</function>
The function performs loose routing as defined in &rfc3261;.
See the &rfc3261; for more details.
<function>loose_route</function> usage
...
loose_route();
...
<function moreinfo="none">strict_route()</function> -- deprecated
If there are any Route HFs in the message, the function takes the
first one, rewrites Request-URI with it's value and removes the first &uri; from
Route HFs.
<function>strict_route</function> usage
...
strict_route();
...
<function moreinfo="none">record_route()</function>
The function adds a new Record-Route header field. The header field will be inserted
in the message before any other Record-Route header fields.
<function>record_route</function> usage
...
record_route();
...
<function moreinfo="none">record_route_preset(string)</function>
This function will put the string into Record-Route, don't use unless you know what
you are doing.
Meaning of the parameters is as follows:
string - String to be inserted into the header field.
<function>record_route_preset</function> usage
...
record_route_preset("1.2.3.4:5090");
...