From d29fd2852f9125f88e52312cf6b0f78355a5db3a Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Wed, 2 Nov 2016 11:01:24 +0100 Subject: [PATCH] modules: readme files regenerated - crypto ... --- modules/crypto/README | 2 +- modules/dispatcher/README | 2 +- modules/nathelper/README | 4 +-- modules/permissions/README | 70 ++++++++++++++++++++++++-------------- modules/sanity/README | 2 +- 5 files changed, 50 insertions(+), 30 deletions(-) diff --git a/modules/crypto/README b/modules/crypto/README index 25eb1bf1784..9cfdd60521c 100644 --- a/modules/crypto/README +++ b/modules/crypto/README @@ -110,7 +110,7 @@ modparam("crypto", "salt", "l0Bh2M8a") Set it to 1 in order to register a callback to core for generation of callid values for requests generated by Kamailio tm module. - This callid genrator uses libssl random and hashing functions for + This callid generator uses libssl random and hashing functions for generating RFC 4122 version 4 UUID with high quality entropy. It is useful when wanting to have new callids that cannot be predicted from previous values. diff --git a/modules/dispatcher/README b/modules/dispatcher/README index ae04118c932..9ce105770f7 100644 --- a/modules/dispatcher/README +++ b/modules/dispatcher/README @@ -687,7 +687,7 @@ Note code=408 or class=400 will never set a backend down even if it is, because internally the Kamailio transaction layer generates a 408 in the case of no response from the remote server, and this internal code - 408 is accepted as vaild value. + 408 is accepted as valid value. Default value is “” (only 200 OK is accepted). diff --git a/modules/nathelper/README b/modules/nathelper/README index f2f01402b32..4d08229c06d 100644 --- a/modules/nathelper/README +++ b/modules/nathelper/README @@ -193,7 +193,7 @@ Chapter 1. Admin Guide 2. NAT pinging types Currently, the nathelper module supports two types of NAT pings: - * UDP package - 4 bytes (zero filled) UDP packages are sent to the + * UDP packet - 4 bytes (zero filled) UDP packets are sent to the contact address. + Advantages: low bandwitdh traffic, easy to generate by Kamailio; @@ -334,7 +334,7 @@ modparam("nathelper", "received_avp", "$avp(i:42)") Which branch flag should be used by the module to identify NATed contacts for which it should perform NAT ping via a SIP request instead - if dummy UDP package. + of dummy UDP packet. Default value is -1 (disabled). diff --git a/modules/permissions/README b/modules/permissions/README index 15259f9018a..931179e4898 100644 --- a/modules/permissions/README +++ b/modules/permissions/README @@ -84,18 +84,20 @@ Emmanuel Schmidbauer 5.1. address_reload 5.2. address_dump 5.3. subnet_dump - 5.4. trusted_reload - 5.5. trusted_dump - 5.6. allow_uri + 5.4. perm_domain_dump + 5.5. trusted_reload + 5.6. trusted_dump + 5.7. allow_uri 6. RPC Commands 6.1. addressReload 6.2. addressDump 6.3. subnetDump - 6.4. testUri basename uri contact - 6.5. trustedReload - 6.6. trustedDump + 6.4. domainDump + 6.5. testUri basename uri contact + 6.6. trustedReload + 6.7. trustedDump List of Examples @@ -194,18 +196,20 @@ Chapter 1. Admin Guide 5.1. address_reload 5.2. address_dump 5.3. subnet_dump - 5.4. trusted_reload - 5.5. trusted_dump - 5.6. allow_uri + 5.4. perm_domain_dump + 5.5. trusted_reload + 5.6. trusted_dump + 5.7. allow_uri 6. RPC Commands 6.1. addressReload 6.2. addressDump 6.3. subnetDump - 6.4. testUri basename uri contact - 6.5. trustedReload - 6.6. trustedDump + 6.4. domainDump + 6.5. testUri basename uri contact + 6.6. trustedReload + 6.7. trustedDump 1. Overview @@ -555,7 +559,7 @@ modparam("permissions", "mask_col", "subnet_length") Example 1.11. Set port_col parameter ... -modparam("permissions", "port_col", "prt") +modparam("permissions", "port_col", "port") ... 3.12. db_mode (integer) @@ -975,9 +979,10 @@ if (allow_trusted("$si", "$proto")) { 5.1. address_reload 5.2. address_dump 5.3. subnet_dump - 5.4. trusted_reload - 5.5. trusted_dump - 5.6. allow_uri + 5.4. perm_domain_dump + 5.5. trusted_reload + 5.6. trusted_dump + 5.7. allow_uri 5.1. address_reload @@ -1002,21 +1007,28 @@ if (allow_trusted("$si", "$proto")) { Parameters: none -5.4. trusted_reload +5.4. perm_domain_dump + + Causes permissions module to dump contents of cache memory domain + table. + + Parameters: none + +5.5. trusted_reload Causes the permissions module to re-read the contents of trusted table into cache memory. Parameters: none -5.5. trusted_dump +5.6. trusted_dump Causes the permissions module to dump the contents of trusted table from cache memory. Parameters: none -5.6. allow_uri +5.7. allow_uri Tests if (URI, Contact) pair is allowed according to the allow/deny files. The files must already have been loaded by Kamailio. @@ -1033,9 +1045,10 @@ if (allow_trusted("$si", "$proto")) { 6.1. addressReload 6.2. addressDump 6.3. subnetDump - 6.4. testUri basename uri contact - 6.5. trustedReload - 6.6. trustedDump + 6.4. domainDump + 6.5. testUri basename uri contact + 6.6. trustedReload + 6.7. trustedDump 6.1. addressReload @@ -1060,7 +1073,14 @@ if (allow_trusted("$si", "$proto")) { Parameters: none -6.4. testUri basename uri contact +6.4. domainDump + + Causes permissions module to dump contents of cache memory domain + table. + + Parameters: none + +6.5. testUri basename uri contact Tests if the (URI, Contact) pair is allowed according to allow/deny files. The files must already have been loaded by Kamailio. @@ -1072,14 +1092,14 @@ if (allow_trusted("$si", "$proto")) { * URI - URI to be tested * Contact - Contact to be tested -6.5. trustedReload +6.6. trustedReload Causes the permissions module to re-read the contents of the trusted database table into cache memory. Parameters: none -6.6. trustedDump +6.7. trustedDump Causes the permissions module to dump contents of the trusted database table from cache memory. diff --git a/modules/sanity/README b/modules/sanity/README index bd200879eea..90ea8789c11 100644 --- a/modules/sanity/README +++ b/modules/sanity/README @@ -129,7 +129,7 @@ modparam("sanity", "default_checks", 1) 'parse uri' will be executed. Default value is 7. This resolves to the following list of parsed URIs: - Request RUI (1), From URI (2) and To URI (4). + Request URI (1), From URI (2) and To URI (4). Example 1.2. Set uri_checks parameter ...