Module: sip-router
Branch: master
Commit: 9b9562a2bdc71e350702e21e25129444e6b805aa
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9b9562a…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Fri Dec 21 10:07:52 2012 +0100
htable Minor correction to RPC docs
---
modules_k/htable/README | 30 +++++++++++++++---------------
modules_k/htable/doc/htable_admin.xml | 12 ++++++------
2 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/modules_k/htable/README b/modules_k/htable/README
index b949b6e..cc7d5ff 100644
--- a/modules_k/htable/README
+++ b/modules_k/htable/README
@@ -61,9 +61,9 @@ Alex Balashov
7. Exported RPC Commands
- 7.1. htable.get
- 7.2. htable.delete
- 7.3. htable.dump
+ 7.1. htable.get htable key
+ 7.2. htable.delete htable key
+ 7.3. htable.dump htable
8. Event routes
@@ -130,9 +130,9 @@ Chapter 1. Admin Guide
7. Exported RPC Commands
- 7.1. htable.get
- 7.2. htable.delete
- 7.3. htable.dump
+ 7.1. htable.get htable key
+ 7.2. htable.delete htable key
+ 7.3. htable.dump htable
8. Event routes
@@ -547,18 +547,18 @@ sht_rm_value_re("ha=>.*");
7. Exported RPC Commands
- 7.1. htable.get
- 7.2. htable.delete
- 7.3. htable.dump
+ 7.1. htable.get htable key
+ 7.2. htable.delete htable key
+ 7.3. htable.dump htable
-7.1. htable.get
+7.1. htable.get htable key
Lists one value in a hash table
Name: htable.get
Parameters:
- * name : Name of the hash table to dump
+ * htable : Name of the hash table to dump
* key : Key name of the hash table value to dump
Example:
@@ -567,14 +567,14 @@ sht_rm_value_re("ha=>.*");
kamcmd htable.get students daniel
...
-7.2. htable.delete
+7.2. htable.delete htable key
Delete one value in a hash table
Name: htable.delete
Parameters:
- * name : Name of the hash table to delete
+ * htable : Name of the hash table to delete
* key : Key name of the hash table value to delete
Example:
@@ -583,14 +583,14 @@ kamcmd htable.get students daniel
kamcmd htable.get students anna
...
-7.3. htable.dump
+7.3. htable.dump htable
Lists all the values in a hash table
Name: dhtable.dump
Parameters:
- * name : Name of the hash table to dump
+ * htable : Name of the hash table to dump
Example:
...
diff --git a/modules_k/htable/doc/htable_admin.xml b/modules_k/htable/doc/htable_admin.xml
index dda48cb..4b6a89f 100644
--- a/modules_k/htable/doc/htable_admin.xml
+++ b/modules_k/htable/doc/htable_admin.xml
@@ -679,7 +679,7 @@ sht_rm_value_re("ha=>.*");
<title>Exported RPC Commands</title>
<section>
<title>
- <function moreinfo="none">htable.get</function>
+ <function moreinfo="none">htable.get htable key</function>
</title>
<para>
Lists one value in a hash table
@@ -689,7 +689,7 @@ sht_rm_value_re("ha=>.*");
</para>
<para>Parameters:</para>
<itemizedlist>
- <listitem><para>name : Name of the hash table to dump</para>
+ <listitem><para>htable : Name of the hash table to dump</para>
</listitem>
<listitem><para>key : Key name of the hash table value to dump</para>
</listitem>
@@ -707,7 +707,7 @@ kamcmd htable.get students daniel
</section>
<section>
<title>
- <function moreinfo="none">htable.delete</function>
+ <function moreinfo="none">htable.delete htable key</function>
</title>
<para>
Delete one value in a hash table
@@ -717,7 +717,7 @@ kamcmd htable.get students daniel
</para>
<para>Parameters:</para>
<itemizedlist>
- <listitem><para>name : Name of the hash table to delete</para>
+ <listitem><para>htable : Name of the hash table to delete</para>
</listitem>
<listitem><para>key : Key name of the hash table value to delete</para>
</listitem>
@@ -735,7 +735,7 @@ kamcmd htable.get students anna
</section>
<section>
<title>
- <function moreinfo="none">htable.dump</function>
+ <function moreinfo="none">htable.dump htable</function>
</title>
<para>
Lists all the values in a hash table
@@ -745,7 +745,7 @@ kamcmd htable.get students anna
</para>
<para>Parameters:</para>
<itemizedlist>
- <listitem><para>name : Name of the hash table to dump</para>
+ <listitem><para>htable : Name of the hash table to dump</para>
</listitem>
</itemizedlist>
THIS IS AN AUTOMATED MESSAGE, DO NOT REPLY.
The following task has a new comment added:
FS#259 - pv_buffer_slots generates seg fault
User who did this - Olle Johansson (oej)
----------
pv_buffer_slots=12
# ------------------------- request routing logic -------------------
route {
#
# Drop, drop, drop and drop
#
exit;
}
----------
More information can be found at the following URL:
http://sip-router.org/tracker/index.php?do=details&task_id=259#comment759
You are receiving this message because you have requested it from the Flyspray bugtracking system. If you did not expect this message or don't want to receive mails in future, you can change your notification settings at the URL shown above.
THIS IS AN AUTOMATED MESSAGE, DO NOT REPLY.
The following task has a new comment added:
FS#259 - pv_buffer_slots generates seg fault
User who did this - Olle Johansson (oej)
----------
It crashes on background and "kamailio -c" as well.
----------
More information can be found at the following URL:
http://sip-router.org/tracker/index.php?do=details&task_id=259#comment758
You are receiving this message because you have requested it from the Flyspray bugtracking system. If you did not expect this message or don't want to receive mails in future, you can change your notification settings at the URL shown above.
Hello,
most of the duplicated or ser-specific modules were sorted out at this
time, next is the situation with the remaining ones.
A) modules that will be renamed using a prefix 'uid_', because they have
a database schema using unique id instead of username and domain:
- auth_db => uid_auth_db
- avp_db => uid_avp_db
- domain => uid_domain
- gflags => uid_gflags (not documented, but this module loads so
called ser global avps)
- uri_db => uid_uri_db
B) modules to become obsolete with some work to be done
- cpl-c - seems that giving a parameter with what user to be used for
loading the cpl scripts will make k and s versions compatible
- maxfwd - different names for config functions
- nathelper - some extra functionality, not sure if can be kept completely
- textops - seems to have some extra cfg functions
- pike - has a rpc command
- registrar/usrloc - avps stored per contact
C) modules to become obsolete, most probably without further work
- permissions - different structures/database table internally, but all
should be achieved using k version (data migration might be required)
D) modules that needs further investigations
- rr - there seems to be some feature related to avps and record-route
parameters/cookies - this module could be just renamed at the end (like rrs)
E) Sample modules, not for real use - they can be kept in this directory
(modules_s[ample])
- print
- print_lib
If anyone has comments regarding these remarks, reply here.
Cheers,
Daniel
--
Daniel-Constantin Mierla - http://www.asipto.comhttp://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda
Module: sip-router
Branch: master
Commit: d36d4de28ad52763ef4e637393997bca44dc6fea
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d36d4de…
Author: Olle E. Johansson <oej(a)edvina.net>
Committer: Olle E. Johansson <oej(a)edvina.net>
Date: Thu Dec 20 20:56:17 2012 +0100
sanity Minor README updates
---
modules/sanity/README | 74 ++++++++++---------
modules/sanity/doc/sanity.xml | 34 +++++----
.../doc/{functions.xml => sanity_functions.xml} | 0
.../sanity/doc/{params.xml => sanity_params.xml} | 2 +-
4 files changed, 60 insertions(+), 50 deletions(-)
diff --git a/modules/sanity/README b/modules/sanity/README
index 6956733..90e7ca3 100644
--- a/modules/sanity/README
+++ b/modules/sanity/README
@@ -1,4 +1,4 @@
-1. Sanity Module
+The Sanity Module - SIP syntax checking
Nils Ohlmeier
@@ -7,38 +7,35 @@ Nils Ohlmeier
Copyright � 2006 iptelorg GmbH
__________________________________________________________________
- 1.1. Overview
- 1.2. Dependencies
- 1.3. Parameters
+ List of Examples
- 1.3.1. default_checks (integer)
- 1.3.2. uri_checks (integer)
- 1.3.3. proxy_require (string)
- 1.3.4. autodrop (integer)
+ 1. Set default_checks parameter
+ 2. Set uri_checks parameter
+ 3. Set proxy_require parameter
+ 4. Set autodrop parameter
+ 5. sanity_check usage
+ 6. sanity_check usage with parameter
+ 7. sanity_check usage with two parameters
- 1.4. Functions
-
- 1.4.1. sanity_check([msg_checks [, uri_checks]])
-
-1.1. Overview
+1. Overview
This module aims to implement several sanity checks on incoming
requests which are suggested or even required by a RFC, but are not
- available yet in the core of SIP-router.
+ available yet in the core of Kamailio.
- These checks are not required by SIP-router itself for its
- functionality. But on the other side it makes not much sence if a
- broken request traverses through a SIP network if it is rejected sooner
- or later by a SIP device any way. As every sanity check cost extra
- performance because of additional parsing and evaluation it is with
- this module now up to the SIP-router adminstrator which checks should
- be done on which request.
+ These checks are not required by Kamailio itself for its functionality.
+ But on the other side it makes not much sence if a broken request
+ traverses through a SIP network if it is rejected sooner or later by a
+ SIP device any way. As every sanity check cost extra performance
+ because of additional parsing and evaluation it is with this module now
+ up to the Kamailio adminstrator which checks should be done on which
+ request.
The following checks are available:
* ruri sip version - (1) - checks if the SIP version in the request
URI is supported, currently only 2.0.
* ruri scheme - (2) - checks if the URI scheme of the request URI is
- supported (sip[s]|tel[s]) by SIP-router.
+ supported (sip[s]|tel[s]) by Kamailio
* required headers - (4) -checks if the minimum set of required
headers to, from, cseq, callid and via is present in the request.
* via sip version - (8) - not working because parser fails already
@@ -57,19 +54,24 @@ Nils Ohlmeier
header are present in the list of the extensions from the module
parameter proxy_require.
* parse uri's - (1024) - checks if the specified URIs are present and
- parseable by the SIP-router parsers
+ parseable by the Kamailio parsers
* digest credentials (2048) Check all instances of digest credentials
in a message. The test checks whether there are all required digest
parameters and have meaningful values.
-1.2. Dependencies
+2. Dependencies
The following modules must be loaded before this module:
* sl - Stateless replies.
-1.3. Parameters
+3. Parameters
-1.3.1. default_checks (integer)
+ 3.1. default_checks (integer)
+ 3.2. uri_checks (integer)
+ 3.3. proxy_require (string)
+ 3.4. autodrop (integer)
+
+3.1. default_checks (integer)
This parameter determines which of the checks from the sanity module
are executed if no parameter was given to the sanity_check function
@@ -87,7 +89,7 @@ Nils Ohlmeier
modparam("sanity", "default_checks", 1)
...
-1.3.2. uri_checks (integer)
+3.2. uri_checks (integer)
This parameter determines which URIs are going to be checked if the
'parse uri' will be executed.
@@ -100,19 +102,19 @@ modparam("sanity", "default_checks", 1)
modparam("sanity", "uri_checks", 3)
...
-1.3.3. proxy_require (string)
+3.3. proxy_require (string)
- This parameter sets the list of supported extensions for this
- SIP-router. The value is expected as a comma separated list of
- extensions. This list is separated into single tokens. Each token from
- a proxy require header will be compared to the tokens from this list.
+ This parameter sets the list of supported extensions for this Kamailio.
+ The value is expected as a comma separated list of extensions. This
+ list is separated into single tokens. Each token from a proxy require
+ header will be compared to the tokens from this list.
Example 3. Set proxy_require parameter
...
modparam("sanity", "proxy_require", "foo, bar")
...
-1.3.4. autodrop (integer)
+3.4. autodrop (integer)
This parameter controls whether the module drops automatically or not
the SIP message if the sanity checks fail. Default value is 1 (auto
@@ -126,9 +128,11 @@ modparam("sanity", "proxy_require", "foo, bar")
modparam("sanity", "autodrop", 1)
...
-1.4. Functions
+4. Functions
+
+ 4.1. sanity_check([msg_checks [, uri_checks]])
-1.4.1. sanity_check([msg_checks [, uri_checks]])
+4.1. sanity_check([msg_checks [, uri_checks]])
This function makes a row of sanity checks over the given SIP request.
The behavior of the function is also controlled by 'autodrop'
diff --git a/modules/sanity/doc/sanity.xml b/modules/sanity/doc/sanity.xml
index 56127b5..8ba8e32 100644
--- a/modules/sanity/doc/sanity.xml
+++ b/modules/sanity/doc/sanity.xml
@@ -1,9 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-<section id="options" xmlns:xi="http://www.w3.org/2001/XInclude">
- <sectioninfo>
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
+%docentities;
+
+]>
+
+<book id="options" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <bookinfo>
+ <title>The Sanity Module - SIP syntax checking</title>
<authorgroup>
<author>
<firstname>Nils</firstname>
@@ -18,24 +25,23 @@
<year>2006</year>
<holder>iptelorg GmbH</holder>
</copyright>
- </sectioninfo>
+ </bookinfo>
- <title>Sanity Module</title>
<section id="sanity.overview">
<title>Overview</title>
<para>
This module aims to implement several sanity checks on incoming
requests which are suggested or even required by a RFC, but are
- not available yet in the core of SIP-router.
+ not available yet in the core of &kamailio;.
</para>
<para>
- These checks are not required by SIP-router itself for its functionality.
+ These checks are not required by &kamailio; itself for its functionality.
But on the other side it makes not much sence if a broken
request traverses through a SIP network if it is rejected sooner
or later by a SIP device any way. As every sanity check cost extra
performance because of additional parsing and evaluation it
- is with this module now up to the SIP-router adminstrator which checks
+ is with this module now up to the &kamailio; adminstrator which checks
should be done on which request.
</para>
<para>
@@ -50,7 +56,7 @@
<listitem>
<para>
ruri scheme - (2) - checks if the URI scheme of the request URI is
- supported (sip[s]|tel[s]) by SIP-router.
+ supported (sip[s]|tel[s]) by &kamailio;
</para>
</listitem>
<listitem>
@@ -105,7 +111,7 @@
<listitem>
<para>
parse uri's - (1024) - checks if the specified URIs are present and
- parseable by the SIP-router parsers
+ parseable by the &kamailio; parsers
</para>
</listitem>
<listitem>
@@ -133,6 +139,6 @@
</para>
</section>
- <xi:include href="params.xml"/>
- <xi:include href="functions.xml"/>
-</section>
+ <xi:include href="sanity_params.xml"/>
+ <xi:include href="sanity_functions.xml"/>
+</book>
diff --git a/modules/sanity/doc/functions.xml b/modules/sanity/doc/sanity_functions.xml
similarity index 100%
rename from modules/sanity/doc/functions.xml
rename to modules/sanity/doc/sanity_functions.xml
diff --git a/modules/sanity/doc/params.xml b/modules/sanity/doc/sanity_params.xml
similarity index 99%
rename from modules/sanity/doc/params.xml
rename to modules/sanity/doc/sanity_params.xml
index 037b6f9..7e2d961 100644
--- a/modules/sanity/doc/params.xml
+++ b/modules/sanity/doc/sanity_params.xml
@@ -62,7 +62,7 @@ modparam("sanity", "uri_checks", 3)
<section id="proxy_require">
<title><varname>proxy_require</varname> (string)</title>
<para>
- This parameter sets the list of supported extensions for this SIP-router.
+ This parameter sets the list of supported extensions for this &kamailio;.
The value is expected as a comma separated list of extensions.
This list is separated into single tokens. Each token from
a proxy require header will be compared to the tokens from this