소스 검색

modules: readme files regenerated - modules ... [skip ci]

Kamailio Dev 7 년 전
부모
커밋
40c4c5c560
7개의 변경된 파일28개의 추가작업 그리고 21개의 파일을 삭제
  1. 11 5
      src/modules/async/README
  2. 7 6
      src/modules/db_perlvdb/README
  3. 2 2
      src/modules/dialog/README
  4. 2 2
      src/modules/p_usrloc/README
  5. 3 3
      src/modules/sanity/README
  6. 2 2
      src/modules/speeddial/README
  7. 1 1
      src/modules/uri_db/README

+ 11 - 5
src/modules/async/README

@@ -136,8 +136,11 @@ modparam("async", "workers", 2)
 
    Example 1.2. async_route usage
 ...
-async_route("RESUME", "4");
-...
+request_route {
+    ...
+    async_route("RESUME", "4");
+    ...
+}
 route[RESUME] {
    send_reply("404", "Not found");
    exit;
@@ -177,7 +180,7 @@ exit;
 
    Example 1.4. async_workers usage
 ...
-; Enable 8 worker processes used by async and other modules
+# Enable 8 worker processes used by async and other modules
 async_workers=8
 ...
 
@@ -197,8 +200,11 @@ async_workers=8
 
    Example 1.5. async_task_route usage
 ...
-async_task_route("RESUME");
-...
+request_route {
+    ...
+    async_task_route("RESUME");
+    ...
+}
 route[RESUME] {
    t_relay();
    exit;

+ 7 - 6
src/modules/db_perlvdb/README

@@ -69,12 +69,12 @@ Chapter 1. Admin Guide
    database access. Relaying of insert, update, query and delete
    operations is supported.
 
-   Modules can be configured to use the perlvdb module as database backend
-   using the db_url_parameter:
+   Modules can be configured to use the db_perlvdb module as database
+   backend using the db_url_parameter:
 modparam("acc", "db_url", "perlvdb:Kamailio::VDB::Adapter::AccountingSIPtrace")
 
    This configuration options tells acc module that it should use the
-   perlvdb module which will in turn use the Perl class
+   db_perlvdb module which will in turn use the Perl class
    Kamailio::VDB::Adapter::AccountingSIPtrace to relay the database
    requests.
 
@@ -86,13 +86,14 @@ modparam("acc", "db_url", "perlvdb:Kamailio::VDB::Adapter::AccountingSIPtrace")
 2.1. Kamailio Modules
 
    The following modules must be loaded before this module:
-     * perl -- Perl module
+     * app_perl -- Perl Application module
 
 2.2. External Libraries or Applications
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * None (Besides the ones mentioned in the perl module documentation).
+     * None (Besides the ones mentioned in the app_perl module
+       documentation).
 
 3. Parameters
 
@@ -136,7 +137,7 @@ Chapter 2. Developer Guide
 
 2. Base class Kamailio::VDB
 
-   A client module has to be configured to use the perlvdb module in
+   A client module has to be configured to use the db_perlvdb module in
    conjunction with a Perl class to provide the functions. The configured
    class needs to inherit from the base class Kamailio::VDB.
 

+ 2 - 2
src/modules/dialog/README

@@ -1755,12 +1755,12 @@ kamcmd dlg.list_ctx [email protected]
    Parameters:
      * callid - callid of dialog to be terminated
      * from_tag - from tag of the dialog to terminated
-     * totag - to tag of the dialog to terminated
+     * to_tag - to tag of the dialog to terminated
 
    The command works only for confirmed dialogs.
 
    RPC Command Format:
-                kamcmd dlg.dlg_terminate_dlg callid12345 fromtag123 totag123
+                kamcmd dlg.terminate_dlg callid12345 fromtag123 totag123
 
 9.6. dlg.end_dlg
 

+ 2 - 2
src/modules/p_usrloc/README

@@ -672,8 +672,8 @@ modparam("p_usrloc", "db_mode", 2)
    databases. For that, if the table was not created by the installation
    script or you choose to install everything by yourself you can use the
    p_usrloc-create.sql SQL script in the database directories in the
-   openser/scripts folder as template. Database and table name can be set
-   with module parameters so they can be changed, but the name of the
+   utils/kamctl/mysql/ folder as template. Database and table name can be
+   set with module parameters so they can be changed, but the name of the
    columns must be as they are in the SQL script. You can also find the
    complete database documentation on the project webpage,
    https://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.

+ 3 - 3
src/modules/sanity/README

@@ -120,10 +120,10 @@ Chapter 1. Admin Guide
    of the sanity_check function. The integer value is the sum of the check
    numbers which should be executed by default.
 
-   Default value is “999”. This resolves to the following list of checks:
+   Default value is “3047”. This resolves to the following list of checks:
    ruri_sip_version (1), ruri_scheme (2), required_headers (4),
-   cseq_method (32), cseq_value (64), cotent_length (128), expires_value
-   (256), proxy_require (512).
+   cseq_method (32), cseq_value (64), content_length (128), expires_value
+   (256), proxy_require (512), digest credentials (2048).
 
    Example 1.1. Set default_checks parameter
 ...

+ 2 - 2
src/modules/speeddial/README

@@ -126,7 +126,7 @@ Chapter 1. Admin Guide
 
    Example 1.1. Set db_url parameter
 ...
-modparam("speeddial", "db_url", "mysql://openser:xxx@localhost/openser")
+modparam("speeddial", "db_url", "mysql://kamailio:xxx@localhost/kamailio")
 ...
 
 3.2. user_column (string)
@@ -231,7 +231,7 @@ modparam("speeddial", "use_domain", 1)
 
    Example 1.9. sd_lookup usage
 ...
-# 'speed_dial' is the default table name created by openser db script
+# 'speed_dial' is the default table name created by kamailio db script
 if(uri=~"sip:[0-9]{2}@.*")
         sd_lookup("speed_dial");
 # use auth username

+ 1 - 1
src/modules/uri_db/README

@@ -125,7 +125,7 @@ Chapter 1. Admin Guide
 
    Example 1.1. Set db_url parameter
 ...
-modparam("uri_db", "db_url", "mysql://username:password@localhost/openser")
+modparam("uri_db", "db_url", "mysql://username:password@localhost/kamailio")
 ...
 
 3.2. db_table (string)