res_pjsip: update qualify_timeout documentation with DNS note

The documentation on qualify_timeout does not explicitly state that the timeout
includes any time required to perform any needed DNS queries on the endpoint.

If the OPTIONS response is delayed due to the DNS query, it can still render an
endpoint as Unreachable if the net time is enough for qualify_timeout to expire.

Resolves: #352
(cherry picked from commit 4d5b479244f70396d5fb9ab973c75a9641db943e)

diff --git a/res/res_pjsip/pjsip_config.xml b/res/res_pjsip/pjsip_config.xml
index 2f4a090f8fcb2bbb22fb34ee075a2aa1744159ae..bd60e5872759fb40910d923ec0edca6c5d42b62e 100644 (file)
--- a/res/res_pjsip/pjsip_config.xml
+++ b/res/res_pjsip/pjsip_config.xml
@@ -1902,7 +1902,8 @@
                                        <synopsis>Timeout for qualify</synopsis>
                                        <description><para>
                                                If the contact doesn't respond to the OPTIONS request before the timeout,
-                                               the contact is marked unavailable.
+                                               the contact is marked unavailable. This includes time spent performing
+                                               any required DNS lookup(s) prior to sending the OPTIONS.
                                                If <literal>0</literal> no timeout. Time in fractional seconds.
                                        </para></description>
                                </configOption>
@@ -2127,7 +2128,8 @@
                                        <synopsis>Timeout for qualify</synopsis>
                                        <description><para>
                                                If the contact doesn't respond to the OPTIONS request before the timeout,
-                                               the contact is marked unavailable.
+                                               the contact is marked unavailable. This includes time spent performing
+                                               any required DNS lookup(s) prior to sending the OPTIONS.
                                                If <literal>0</literal> no timeout. Time in fractional seconds.
                                        </para></description>
                                </configOption>