Table of Contents
List of Examples
sl_send_reply usagesend_reply usagesl_reply_error usageTable of Contents
The SL module allows Kamailio to act as a stateless UA server and generate replies to SIP requests without keeping state. That is beneficial in many scenarios, in which you wish not to burden server's memory and scale well.
The SL module needs to filter ACKs sent after a local stateless reply to an INVITE was generated. To recognize such ACKs, Kamailio adds a special "signature" in to-tags. This signature is sought for in incoming ACKs, and if included, the ACKs are absorbed.
To speed up the filtering process, the module uses a timeout mechanism. When a reply is sent, a timer is set. As time as the timeout didn't hit, the incoming ACK requests will be checked using TO tag value. Once the timer expires, all the ACK are let through - a long time passed till it sent a reply, so it does not expect any ACK that have to be blocked.
The ACK filtering may fail in some rare cases. If you think these matter to you, better use stateful processing (tm module) for INVITE processing. Particularly, the problem happens when a UA sends an INVITE which already has a to-tag in it (e.g., a re-INVITE) and Kamailio want to reply to it. Than, it will keep the current to-tag, which will be mirrored in ACK. Kamailio will not see its signature and forward the ACK downstream. Caused harm is not bad--just a useless ACK is forwarded.
The following modules must be loaded before this module:
TM - transaction module, if you want to use the transactional send_reply functionality.
If the module should generate and export statistics to the core manager. A zero value means disabled.
SL module provides statistics about how many replies were sent ( splitted per code classes) and how many local ACKs were filtered out.
Default value is 1 (enabled).
For the current request, a reply is sent back having the given code and text reason. The reply is sent stateless, totally independent of the Transaction module and with no retransmission for the INVITE's replies. 'code' and 'reason' can contain pseudo-variables that are replaced at runtime.
Meaning of the parameters is as follows:
code - Return code.
reason - Reason phrase.
This function can be used from REQUEST_ROUTE, ERROR_ROUTE.
Example 1.2. sl_send_reply usage
...
sl_send_reply("404", "Not found");
...
sl_send_reply("$err.rcode", "$err.rreason");
...
For the current request, a reply is sent back having the given code and text reason. The reply is sent stateful or stateless, depending of the Transaction module: if the transaction for current request has created, then the reply is sent stateful, otherwise stateless.
Meaning of the parameters is as follows:
code - Return code.
reason - Reason phrase.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, ERROR_ROUTE.
Example 1.3. send_reply usage
...
send_reply("404", "Not found");
...
send_reply("403", "Invalid user - $fU");
...