Module: sip-router
Branch: master
Commit: a86074046ebf5e325413662d099711c00ee24930
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a860740…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Sun Oct 14 21:02:52 2012 +0200
p_userloc Fixing the database URLs as entities
---
modules_k/p_usrloc/README | 21 ++++++++++-----------
modules_k/p_usrloc/doc/p_usrloc_admin.xml | 20 +++++++++-----------
2 files changed, 19 insertions(+), 22 deletions(-)
diff --git a/modules_k/p_usrloc/README b/modules_k/p_usrloc/README
index fb859d2..6736b43 100644
--- a/modules_k/p_usrloc/README
+++ b/modules_k/p_usrloc/README
@@ -25,7 +25,7 @@ Marius Zbihlei
2.1. Kamailio Modules
2.2. External Libraries or Applications
- 3. Exported Parameters
+ 3. Parameters
3.1. write_db_url (string)
3.2. read_db_url (string)
@@ -131,7 +131,7 @@ Chapter 1. User's Guide
2.1. Kamailio Modules
2.2. External Libraries or Applications
- 3. Exported Parameters
+ 3. Parameters
3.1. write_db_url (string)
3.2. read_db_url (string)
@@ -245,7 +245,7 @@ Warning
running Kamailio with this module loaded:
* None.
-3. Exported Parameters
+3. Parameters
3.1. write_db_url (string)
3.2. read_db_url (string)
@@ -275,12 +275,12 @@ Warning
The url to the master database where errors are written to.
- Default value is "mysql://openser:openserrw@localhost/openser".
+ Default value is "mysql://openser:openserrw@localhost/openser"
Example 1.1. Set write_db_url parameter
...
-modparam("p_usrloc", "write_db_url", "mysql://openser:openserrw@localhost/opense
-r")
+modparam("p_usrloc", "write_db_url", "mysql://username:password@localhost/databa
+sename")
...
3.2. read_db_url (string)
@@ -289,12 +289,11 @@ r")
from. It is seperated from write access, so for better performance, a
local replicate can be used for read access.
- Default value is "mysql://openser:openserrw@localhost/openser".
+ Default value is mysql://openser:openserrw@localhost/openser .
Example 1.2. Set read_db_url parameter
...
-modparam("p_usrloc", "read_db_url", "mysql://openser:openserrw@localhost/openser
-")
+modparam("p_usrloc", "read_db_url", "mysql://user:passwd@localhost/db")
...
3.3. reg_db_table (string)
@@ -659,8 +658,8 @@ modparam("p_usrloc", "db_mode", 2)
+----+----+------+--------+--------+---------------------+-------+----+
...
- The urls are omitted for a better overview, but you can use standard
- openser database URLs like mysql://openser:openserrw@localhost/openser.
+ The URLs are omitted for a better overview, but you can use standard
+ Kamailio database URLs like mysql://openser:openserrw@localhost/openser
Databases don't need to be on different hosts, e.g. for testing
purposes.
diff --git a/modules_k/p_usrloc/doc/p_usrloc_admin.xml b/modules_k/p_usrloc/doc/p_usrloc_admin.xml
index dbea4f7..55703c1 100644
--- a/modules_k/p_usrloc/doc/p_usrloc_admin.xml
+++ b/modules_k/p_usrloc/doc/p_usrloc_admin.xml
@@ -9,6 +9,7 @@
]>
<!-- Module User's Guide -->
+
<chapter>
<chapterinfo>
</chapterinfo>
@@ -111,15 +112,13 @@
The url to the master database where errors are written to.
</para>
<para>
- <emphasis>
- Default value is <quote>mysql://openser:openserrw@localhost/openser</quote>.
- </emphasis>
+ Default value is <quote>&defaultdb;</quote>
</para>
<example>
<title>Set <varname>write_db_url</varname> parameter</title>
<programlisting format="linespecific">
...
-modparam("p_usrloc", "write_db_url", "mysql://openser:openserrw@localhost/openser")
+modparam("p_usrloc", "write_db_url", "mysql://username:password@localhost/databasename")
...
</programlisting>
</example>
@@ -132,15 +131,14 @@ modparam("p_usrloc", "write_db_url", "mysql://openser:openserrw@localhost/opense
performance, a local replicate can be used for read access.
</para>
<para>
- <emphasis>
- Default value is <quote>mysql://openser:openserrw@localhost/openser</quote>.
+ <emphasis>Default value is &defaultdb; .
</emphasis>
</para>
<example>
<title>Set <varname>read_db_url</varname> parameter</title>
<programlisting format="linespecific">
...
-modparam("p_usrloc", "read_db_url", "mysql://openser:openserrw@localhost/openser")
+modparam("p_usrloc", "read_db_url", "mysql://user:passwd@localhost/db")
...
</programlisting>
</example>
@@ -682,10 +680,10 @@ modparam("p_usrloc", "db_mode", 2)
+----+----+------+--------+--------+---------------------+-------+----+
...
</programlisting>
- <para>The urls are omitted for a better overview, but you can use
- standard openser database URLs like
- mysql://openser:openserrw@localhost/openser. Databases don't
- need to be on different hosts, e.g. for testing purposes.
+ <para>The URLs are omitted for a better overview, but you can use
+ standard &kamailio; database URLs like
+ &defaultdb;
+ Databases don't need to be on different hosts, e.g. for testing purposes.
</para>
</example>
<para>
According to the 3.3 docs, this function in the ™ module is no longer needed. Is this correct?
If so, should someone remove it?
Hmm. All mentions of ™ gets automatically converted to a trademark sign in my mailer. I mean the T M Module :-)
/O
--------
1.4.6. delete_timer (integer)
Time after which a to-be-deleted transaction currently ref-ed by a process will be tried to be deleted again (in milliseconds).
Note: this parameter is obsolete for ser 2.1 (in 2.1 the transaction is deleted the moment it's not referenced anymore).
Default value is 200 milliseconds.
Example 6. Set delete_timer parameter
...
modparam("tm", "delete_timer", 100)
...
Module: sip-router
Branch: master
Commit: 2522a1ce3886a764c6cf09d8cc55b8c6dd1bf57e
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=2522a1c…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Sun Oct 14 18:20:42 2012 +0200
siputils: README typo fixes
---
modules_k/siputils/README | 25 +++++++++++++------------
modules_k/siputils/doc/siputils_admin.xml | 11 ++++++-----
2 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/modules_k/siputils/README b/modules_k/siputils/README
index 0a54014..d75b60c 100644
--- a/modules_k/siputils/README
+++ b/modules_k/siputils/README
@@ -189,11 +189,11 @@ Chapter 1. Admin Guide
parallel on the phone. So its necessary to drop the 183 in this cases
and send a 180 instead.
- This module provides a function to answer OPTIONS requests which are
- directed to the server itself. This means an OPTIONS request which has
- the address of the server in the request URI, and no username in the
- URI. The request will be answered with a 200 OK which the capabilities
- of the server.
+ This module also provides a function to answer OPTIONS requests which
+ are directed to the server itself. This means an OPTIONS request which
+ has the address of the server in the request URI, and no username in
+ the URI. The request will be answered with a 200 OK with the
+ capabilities of the server.
To answer OPTIONS request directed to your server is the easiest way
for is-alive-tests on the SIP (application) layer from remote (similar
@@ -292,8 +292,8 @@ modparam("siputils", "contact_flds_separator", "-")
This parameter is the content of the Accept-Language header field. You
can set any language code which you prefer for error descriptions from
- other devices, but presumably there are not much devices around which
- support other languages then the default English.
+ other devices, but presumably there are not many devices around which
+ support other languages than the default English.
Default value is "en".
@@ -304,9 +304,10 @@ modparam("siputils", "options_accept_language", "de")
3.6. options_support (string)
- This parameter is the content of the Support header field. Please do
- not change the default value, because Kamailio currently does not
- support any of the SIP extensions registered at the IANA.
+ This parameter is the content of the Support header field, indicating
+ SIP extensions. Please do not change the default value, because
+ Kamailio currently does not support any of the SIP extensions
+ registered at the IANA.
Default value is "".
@@ -574,8 +575,8 @@ if (is_uri_user_e164("$avp(i:705)") {
contact_flds_separator module parameter.
Note: This function discards all of the URI parameters. Thus, none of
- the paramters (except the transport parameter which is encoded into the
- userpart) can be restored.
+ the parameters (except the transport parameter which is encoded into
+ the userpart) can be restored.
The function returns negative on error, 1 on success.
diff --git a/modules_k/siputils/doc/siputils_admin.xml b/modules_k/siputils/doc/siputils_admin.xml
index d8a66e9..5379da0 100644
--- a/modules_k/siputils/doc/siputils_admin.xml
+++ b/modules_k/siputils/doc/siputils_admin.xml
@@ -26,11 +26,11 @@
So its necessary to drop the 183 in this cases and send a 180 instead.
</para>
<para>
- This module provides a function to answer OPTIONS requests which
+ This module also provides a function to answer OPTIONS requests which
are directed to the server itself. This means an OPTIONS request
which has the address of the server in the request URI, and no
username in the URI. The request will be answered with a 200 OK
- which the capabilities of the server.
+ with the capabilities of the server.
</para>
<para>
To answer OPTIONS request directed to your server is the easiest
@@ -176,7 +176,7 @@ modparam("siputils", "contact_flds_separator", "-")
This parameter is the content of the Accept-Language header field.
You can set any language code which you prefer for error
descriptions from other devices, but presumably there are not
- much devices around which support other languages then the
+ many devices around which support other languages than the
default English.
</para>
<para>
@@ -196,7 +196,8 @@ modparam("siputils", "options_accept_language", "de")
<section>
<title><varname>options_support</varname> (string)</title>
<para>
- This parameter is the content of the Support header field.
+ This parameter is the content of the Support header field,
+ indicating SIP extensions.
Please do not change the default value, because &kamailio; currently
does not support any of the SIP extensions registered at the IANA.
</para>
@@ -593,7 +594,7 @@ if (is_uri_user_e164("$avp(i:705)") {
module parameter.
</para>
<para>
- Note: This function discards all of the URI parameters. Thus, none of the paramters
+ Note: This function discards all of the URI parameters. Thus, none of the parameters
(except the transport parameter which is encoded into the userpart) can be restored.
</para>
<para>
Module: sip-router
Branch: master
Commit: 4c45f67a42ea76c909893bd684cac03fde8d5c2b
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=4c45f67…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Sun Oct 14 18:02:45 2012 +0200
SL doc: fix typos
---
modules/sl/README | 29 +++++++++++++++--------------
modules/sl/doc/functions.xml | 4 ++--
modules/sl/doc/sl.xml | 18 +++++++++---------
3 files changed, 26 insertions(+), 25 deletions(-)
diff --git a/modules/sl/README b/modules/sl/README
index 19ae7b6..03f8d26 100644
--- a/modules/sl/README
+++ b/modules/sl/README
@@ -53,10 +53,10 @@ Daniel-Constantin Mierla
1.1. Overview
- The SL module allows ser 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 allows the SIP server 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, ser adds a special
@@ -64,17 +64,18 @@ Daniel-Constantin Mierla
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 us set. As time as the timer is valid,
- 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.
+ When a reply is sent, a timer us set. As long as the timer is valid,
+ the incoming ACK requests will be checked using TO tag value. Once the
+ timer expires, all the ACK messages 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
+ 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 SER want to
- reply to it. Than, it will keep the current to-tag, which will be
- mirrored in ACK. SER will not see its signature and forward the ACK
+ which already has a to-tag in it (e.g., a re-INVITE) and the server
+ want to reply to it. Then, it will keep the current to-tag, which will
+ be mirrored in ACK. SER will not see its signature and forward the ACK
downstream. Caused harm is not bad--just a useless ACK is forwarded.
1.2. Parameters
@@ -134,8 +135,8 @@ sl_send_reply("404", "Not found");
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
- TM module: if the transaction for current request is created, then the
- reply is sent stateful, otherwise stateless.
+ TM module: if a transaction exists for the current request, then the
+ reply is sent statefully, otherwise stateless.
Meaning of the parameters is as follows:
* code - Return code.
diff --git a/modules/sl/doc/functions.xml b/modules/sl/doc/functions.xml
index 2cfe4d9..63abcb6 100644
--- a/modules/sl/doc/functions.xml
+++ b/modules/sl/doc/functions.xml
@@ -44,8 +44,8 @@ sl_send_reply("404", "Not found");
<para>
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 TM module: if the transaction for current request is
- created, then the reply is sent stateful, otherwise stateless.
+ the <acronym>TM</acronym> module: if a transaction exists for the current
+ request, then the reply is sent statefully, otherwise stateless.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
diff --git a/modules/sl/doc/sl.xml b/modules/sl/doc/sl.xml
index 5be9974..4b5a402 100644
--- a/modules/sl/doc/sl.xml
+++ b/modules/sl/doc/sl.xml
@@ -33,7 +33,7 @@
<section id="sl.overview">
<title>Overview</title>
<para>
- The <acronym>SL</acronym> module allows ser to act as a stateless
+ The <acronym>SL</acronym> module allows the SIP server 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.
@@ -47,18 +47,18 @@
</para>
<para>
To speed up the filtering process, the module uses a timeout
- mechanism. When a reply is sent, a timer us set. As time as the
- timer is valid, 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.
+ mechanism. When a reply is sent, a timer us set. As long as the
+ timer is valid, the incoming ACK requests will be checked using TO
+ tag value. Once the timer expires, all the ACK messages are let
+ through - a long time passed till it sent a reply, so it does not
+ expect any ACK that have to be blocked.
</para>
<para>
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
+ matter to you, better use stateful processing (<acronym>TM</acronym>
+ 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 SER want to reply to it. Than, it will keep the
+ re-INVITE) and the server want to reply to it. Then, it will keep the
current to-tag, which will be mirrored in ACK. SER will not see
its signature and forward the ACK downstream. Caused harm is not
bad--just a useless ACK is forwarded.