Skip to content

Commit

Permalink
modules: readme files regenerated - async ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Oct 16, 2024
1 parent cce29af commit 1869a9d
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 25 deletions.
17 changes: 11 additions & 6 deletions src/modules/async/README
Original file line number Diff line number Diff line change
Expand Up @@ -241,13 +241,19 @@ route[RESUME] {
4.3. async_sleep(seconds)

Simulate a sleep of 'seconds' and then continue the processing of SIP
request with the next action. In case of internal errors, the function
returns false.
request with the next action. Note that the processing continues till
the last action in the current route block. Consider using
async_route() instead if you want to control better what is executed
after the wait time. Beacuse the execution is resumed in another
process, do not use private memory variables before and after the async
sleep.

The sleep parameter represent the number of seconds to suspend the
processing of SIP request. Maximum value is 100. The parameter can be a
static integer or a variable holding an integer.

In case of internal errors, the function returns false.

This function can be used from REQUEST_ROUTE.

Example 1.6. async_sleep usage
Expand All @@ -259,10 +265,9 @@ exit;

4.4. async_ms_sleep(milliseconds)

Simulate a sleep of 'milliseconds' and then continue the processing of
SIP request with the next action. In case of internal errors, the
function returns false. This function works only if the ms_timer
parameter has a value greater than 0.
Similar to async_sleep(), but with a 'milliseconds' parameter. This
function works only if the ms_timer parameter has a value greater than
0.

The sleep parameter represent the number of milliseconds to suspend the
processing of SIP request. Maximum value is 30000 (30 sec). The
Expand Down
42 changes: 23 additions & 19 deletions src/modules/tls/README
Original file line number Diff line number Diff line change
Expand Up @@ -241,24 +241,9 @@ Chapter 1. Admin Guide
this module must be loaded and enable_tls=yes core setting must be
added to the Kamailio config file.

IMPORTANT: the tls module must be loaded before any other Kamailio
module that uses libssl (OpenSSL library). A safe option is to have the
tls module loaded first (be in the first "loadmodule" in Kamailio.cfg).

IMPORTANT: For libssl v3.x, the core parameter "tls_threads_mode" has
to be set, see the Core Cookbook for possible values.

IMPORTANT: using this module compiled with newer versions of libssl
(e.g., v1.1+) may require Kamailio to be started with --atexit=no
command line parameters to avoid calling C atexit callbacks inside the
process ending during daemonize procedure as well as during shut down,
which can lead to crashes because it destroys and then accesses shared
memory. For example, such case has been reported for Ubuntu 20.04 or
RedHat 8.

Note: with some particular combination of OS, openssl and mysql-client
libraries, there were reports of random crashes, in such case try to
set the db_mysql module parameter opt_ssl_mode to 1.
Read the "Important Notes" section because it has relevant information
about configuring properly the module for various libssl versions,
components and operating systems.

2. Quick Start

Expand Down Expand Up @@ -300,7 +285,7 @@ request_route {
3. Important Notes

The TLS module needs some special options enabled when compiling
Kamailio. These options are enabled by default, however in case you're
Kamailio. These options are enabled by default, however in case you are
using a modified Kamailio version or Makefile, make sure that you
enable -DUSE_TLS and -DTLS_HOOKS (or compile with make TLS_HOOKS=1
which will take care of both options).
Expand Down Expand Up @@ -345,6 +330,25 @@ request_route {

The bug reports can be viewed at http://rt.openssl.org/.

Note 1: the tls module must be loaded before any other Kamailio module
that uses libssl (OpenSSL library). A safe option is to have the tls
module loaded first (be in the first "loadmodule" in Kamailio.cfg).

Note 2: for libssl v3.x, the core parameter "tls_threads_mode" has to
be set, see the Core Cookbook for possible values.

Note 3: using this module compiled with newer versions of libssl (e.g.,
v1.1+) may require Kamailio to be started with --atexit=no command line
parameters to avoid calling C atexit callbacks inside the process
ending during daemonize procedure as well as during shut down, which
can lead to crashes because it destroys and then accesses shared
memory. For example, such case has been reported for Ubuntu 20.04 or
RedHat 8.

Note 4: with some particular combination of OS, openssl and
mysql-client libraries, there were reports of random crashes, in such
case try to set the db_mysql module parameter opt_ssl_mode to 1.

4. Compiling the TLS Module

In most case compiling the TLS module is as simple as:
Expand Down

0 comments on commit 1869a9d

Please sign in to comment.