diff --git a/src/modules/async/doc/async_admin.xml b/src/modules/async/doc/async_admin.xml index 027cea11ed7..152c6be5db7 100644 --- a/src/modules/async/doc/async_admin.xml +++ b/src/modules/async/doc/async_admin.xml @@ -234,8 +234,11 @@ route[RESUME] { 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 @@ -243,6 +246,9 @@ route[RESUME] { 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. @@ -262,15 +268,13 @@ exit; 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 parameter can be - a static integer or a variable holding an integer. + processing of SIP request. Maximum value is 30000 (30 sec). The parameter + can be a static integer or a variable holding an integer. This function can be used from REQUEST_ROUTE.