Skip to content

Commit

Permalink
modules: readme files regenerated - dialog ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@kamailio-dev
kamailio-dev committed May 17, 2022
1 parent 6d7d128 commit 9051033
Showing 1 changed file with 108 additions and 54 deletions.
162 changes: 108 additions & 54 deletions src/modules/dialog/README
View file
Expand Up @@ -128,15 +128,17 @@ Julien Klingenmeyer
7.10. dlg_manage()
7.11. dlg_bridge(from, to, op)
7.12. dlg_get(callid, ftag, ttag)
7.13. is_known_dlg()
7.14. dlg_set_timeout(timeout [, h_entry, h_id])
7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
7.16. dlg_set_property(attr)
7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
7.18. dlg_set_ruri()
7.19. dlg_db_load_callid(cival)
7.20. dlg_db_load_extra()
7.21. dlg_reset_property(attr)
7.13. dlg_get_var(callid, ftag, ttag, name, dst)
7.14. dlg_set_var(callid, ftag, ttag, name, value)
7.15. is_known_dlg()
7.16. dlg_set_timeout(timeout [, h_entry, h_id])
7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
7.18. dlg_set_property(attr)
7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
7.20. dlg_set_ruri()
7.21. dlg_db_load_callid(cival)
7.22. dlg_db_load_extra()
7.23. dlg_reset_property(attr)

8. Statistics

Expand Down Expand Up @@ -267,15 +269,17 @@ Julien Klingenmeyer
1.73. dlg_manage usage
1.74. dlg_bridge usage
1.75. dlg_get usage
1.76. is_known_dlg() usage
1.77. dlg_set_timeout usage
1.78. dlg_set_timeout_by_profile usage
1.79. dlg_set_property usage
1.80. dlg_remote_profile usage
1.81. dlg_set_ruri() usage
1.82. dlg_db_load_callid() usage
1.83. dlg_db_load_extra() usage
1.84. dlg_reset_property usage
1.76. dlg_get_var usage
1.77. dlg_set_var usage
1.78. is_known_dlg() usage
1.79. dlg_set_timeout usage
1.80. dlg_set_timeout_by_profile usage
1.81. dlg_set_property usage
1.82. dlg_remote_profile usage
1.83. dlg_set_ruri() usage
1.84. dlg_db_load_callid() usage
1.85. dlg_db_load_extra() usage
1.86. dlg_reset_property usage

Chapter 1. Admin Guide

Expand Down Expand Up @@ -370,15 +374,17 @@ Chapter 1. Admin Guide
7.10. dlg_manage()
7.11. dlg_bridge(from, to, op)
7.12. dlg_get(callid, ftag, ttag)
7.13. is_known_dlg()
7.14. dlg_set_timeout(timeout [, h_entry, h_id])
7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
7.16. dlg_set_property(attr)
7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
7.18. dlg_set_ruri()
7.19. dlg_db_load_callid(cival)
7.20. dlg_db_load_extra()
7.21. dlg_reset_property(attr)
7.13. dlg_get_var(callid, ftag, ttag, name, dst)
7.14. dlg_set_var(callid, ftag, ttag, name, value)
7.15. is_known_dlg()
7.16. dlg_set_timeout(timeout [, h_entry, h_id])
7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
7.18. dlg_set_property(attr)
7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
7.20. dlg_set_ruri()
7.21. dlg_db_load_callid(cival)
7.22. dlg_db_load_extra()
7.23. dlg_reset_property(attr)

8. Statistics

Expand Down Expand Up @@ -1468,15 +1474,17 @@ modparam("dialog", "keep_proxy_rr", 1)
7.10. dlg_manage()
7.11. dlg_bridge(from, to, op)
7.12. dlg_get(callid, ftag, ttag)
7.13. is_known_dlg()
7.14. dlg_set_timeout(timeout [, h_entry, h_id])
7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
7.16. dlg_set_property(attr)
7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
7.18. dlg_set_ruri()
7.19. dlg_db_load_callid(cival)
7.20. dlg_db_load_extra()
7.21. dlg_reset_property(attr)
7.13. dlg_get_var(callid, ftag, ttag, name, dst)
7.14. dlg_set_var(callid, ftag, ttag, name, value)
7.15. is_known_dlg()
7.16. dlg_set_timeout(timeout [, h_entry, h_id])
7.17. dlg_set_timeout_by_profile(profile, [value], timeout)
7.18. dlg_set_property(attr)
7.19. dlg_remote_profile(cmd, profile, value, uid, expires)
7.20. dlg_set_ruri()
7.21. dlg_db_load_callid(cival)
7.22. dlg_db_load_extra()
7.23. dlg_reset_property(attr)

7.1. set_dlg_profile(profile,[value])

Expand Down Expand Up @@ -1719,7 +1727,53 @@ if(dlg_get("abcdef", "123", "456"))
}
...

7.13. is_known_dlg()
7.13. dlg_get_var(callid, ftag, ttag, name, dst)

Get dlg_var of another dialog value based on Call-ID, From-Tag and
To-Tag parameters.

Meaning of the parameters is as follows:
* callid - SIP call-id.
* ftag - SIP From tag.
* ttag - SIP To tag.
* name - key name of the $dlg_var.
* dst - pv to store the value of $dlg_var(name).

This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
ONREPLY_ROUTE and FAILURE_ROUTE.

Example 1.76. dlg_get_var usage
...
if(dlg_get_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
{
xdbg("$$dlg_var(test):$var(tmp)\n");
}
...

7.14. dlg_set_var(callid, ftag, ttag, name, value)

Set dlg_var of another dialog value based on Call-ID, From-Tag and
To-Tag parameters.

Meaning of the parameters is as follows:
* callid - SIP call-id.
* ftag - SIP From tag.
* ttag - SIP To tag.
* name - key name of the $dlg_var.
* value - string value to store at $dlg_var(name).

This function can be used from BRANCH_ROUTE, REQUEST_ROUTE,
ONREPLY_ROUTE and FAILURE_ROUTE.

Example 1.77. dlg_set_var usage
...
if(dlg_set_var("$var(ci)", "$var(ft)", "456", "test", "$var(tmp)"))
{
xdbg("set $$dlg_var(test):$var(tmp)\n");
}
...

7.15. is_known_dlg()

This function checks if the current SIP message being processed belongs
to any transaction within an active dialog that the dialog module is
Expand All @@ -1735,7 +1789,7 @@ if(dlg_get("abcdef", "123", "456"))
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
and FAILURE_ROUTE.

Example 1.76. is_known_dlg() usage
Example 1.78. is_known_dlg() usage
...
if(!uri == myself) {
if(is_known_dlg()) {
Expand All @@ -1744,7 +1798,7 @@ if(!uri == myself) {
}
...

7.14. dlg_set_timeout(timeout [, h_entry, h_id])
7.16. dlg_set_timeout(timeout [, h_entry, h_id])

Set the dialog timeout. Dialog timeout will be updated if it was
already set. If h_entry and h_id parameters are not provided, the
Expand All @@ -1759,15 +1813,15 @@ if(!uri == myself) {

This function can be used from ANY_ROUTE.

Example 1.77. dlg_set_timeout usage
Example 1.79. dlg_set_timeout usage
...
if(dlg_set_timeout("180", "123", "456"))
{
...
}
...

7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
7.17. dlg_set_timeout_by_profile(profile, [value], timeout)

Like dlg_set_timeout(), but simultaneously sets the timeout of all
dialogs in a given profile. Can be constrained by profile value.
Expand All @@ -1781,15 +1835,15 @@ if(dlg_set_timeout("180", "123", "456"))

This function can be used from ANY_ROUTE.

Example 1.78. dlg_set_timeout_by_profile usage
Example 1.80. dlg_set_timeout_by_profile usage
...
# All dialogs belonging to user abc123 (tracked via set_dlg_profile())
# will be timed out in 3 seconds.

dlg_set_timeout_by_profile("users", "abc123", "3");
...

7.16. dlg_set_property(attr)
7.18. dlg_set_property(attr)

Set a dialog property - an attribute that enable/disable various
behaviours (e.g., sending keep alive requests).
Expand All @@ -1813,14 +1867,14 @@ dlg_set_timeout_by_profile("users", "abc123", "3");

This function can be used from ANY_ROUTE.

Example 1.79. dlg_set_property usage
Example 1.81. dlg_set_property usage
...
dlg_set_property("ka-src");
dlg_set_property("ka-dst");
dlg_set_property("timeout-noreset");
...

7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
7.19. dlg_remote_profile(cmd, profile, value, uid, expires)

Manage remote profile via config file. A remote profile item is
considered when the dialog is not managed by this server instance. The
Expand All @@ -1841,20 +1895,20 @@ dlg_set_property("timeout-noreset");

This function can be used from ANY_ROUTE.

Example 1.80. dlg_remote_profile usage
Example 1.82. dlg_remote_profile usage
...
$var(exp) = 3600 + $Ts;
dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
...

7.18. dlg_set_ruri()
7.20. dlg_set_ruri()

This function sets the R-URI with the corresponding endpoint address
stored in dialog structure (i.e., its Contact field).

This function can be used from ANY_ROUTE.

Example 1.81. dlg_set_ruri() usage
Example 1.83. dlg_set_ruri() usage
...
if(has_totag() and is_present_hf("Route") and uri==myself ) {
if(dlg_set_ruri()) {
Expand All @@ -1863,14 +1917,14 @@ if(has_totag() and is_present_hf("Route") and uri==myself ) {
}
...

7.19. dlg_db_load_callid(cival)
7.21. dlg_db_load_callid(cival)

Load dialog record from database matching on Call-Id provided as
parameter.

This function can be used from ANY_ROUTE.

Example 1.82. dlg_db_load_callid() usage
Example 1.84. dlg_db_load_callid() usage
...
if(has_totag()) {
if(!is_known_dlg()) {
Expand All @@ -1882,14 +1936,14 @@ if(has_totag()) {
}
...

7.20. dlg_db_load_extra()
7.22. dlg_db_load_extra()

Load all dialog records from database that are not in memory of the
current Kamailio instance.

This function can be used from ANY_ROUTE.

Example 1.83. dlg_db_load_extra() usage
Example 1.85. dlg_db_load_extra() usage
...
if(has_totag()) {
if(!is_known_dlg()) {
Expand All @@ -1901,7 +1955,7 @@ if(has_totag()) {
}
...

7.21. dlg_reset_property(attr)
7.23. dlg_reset_property(attr)

Reset a dialog property - an attribute that enable/disable various
behaviours (e.g., sending keep alive requests).
Expand All @@ -1915,7 +1969,7 @@ if(has_totag()) {

This function can be used from ANY_ROUTE.

Example 1.84. dlg_reset_property usage
Example 1.86. dlg_reset_property usage
...
dlg_reset_property("ka-src");
dlg_reset_property("ka-dst");
Expand Down

0 comments on commit 9051033

Please sign in to comment.