[sr-dev] git:master:ae13686c: lost: lost_held_dereference() documentation added and code comment corrected

[Wolfgang Kampichler]

Module: kamailio
Branch: master
Commit: ae13686c80b03693ee2195d38a8c8eb0ede0d0dc
URL: https://github.com/kamailio/kamailio/commit/ae13686c80b03693ee2195d38a8c8eb0ede0d0dc

Author: Wolfgang Kampichler <dev at kampichler.info>
Committer: Wolfgang Kampichler <dev at kampichler.info>
Date: 2021-05-03T11:00:41+02:00

lost: lost_held_dereference() documentation added and code comment corrected

---

Modified: src/modules/lost/doc/lost_admin.xml
Modified: src/modules/lost/response.c

---

Diff:  https://github.com/kamailio/kamailio/commit/ae13686c80b03693ee2195d38a8c8eb0ede0d0dc.diff
Patch: https://github.com/kamailio/kamailio/commit/ae13686c80b03693ee2195d38a8c8eb0ede0d0dc.patch

---

diff --git a/src/modules/lost/doc/lost_admin.xml b/src/modules/lost/doc/lost_admin.xml
index 7f4597632b..f8065770d9 100644
--- a/src/modules/lost/doc/lost_admin.xml
+++ b/src/modules/lost/doc/lost_admin.xml
@@ -429,9 +429,23 @@ xlog("L_INFO", "HELD locationRequest: Result code $var(res)\nUrl: $var(url)\n$va
                     </para></listitem>
 			    </itemizedlist>
 			<para>
-			The return value is 200 on success, 400 if an internal error occured, or 500 if an
-            error code is returned in the HELD response.
+			The return value is 200..203 on success, 400 if an internal error occured, or 500 if an
+            error code is returned in the HELD response. Success codes in detail are as follows:
 	    	</para>
+			<itemizedlist>
+                <listitem><para>
+                    <emphasis>200</emphasis> - received 200 OK, but neither location-info nor locationURI element found
+                </para></listitem>
+                <listitem><para>
+                    <emphasis>201</emphasis> - received 200 OK with locationURI (aka Location-by-Reference)
+                </para></listitem>
+                <listitem><para>
+                    <emphasis>202</emphasis> - received 200 OK with location-info element (aka Location-by-Value)
+                </para></listitem>
+                <listitem><para>
+                    <emphasis>203</emphasis> - received 200 OK with location-info and locationURI element
+                </para></listitem>
+            </itemizedlist>            
 			<para>
 			This function can be used from REQUEST_ROUTE,
 			ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE.
diff --git a/src/modules/lost/response.c b/src/modules/lost/response.c
index caa86732ed..cc6d65ad2a 100644
--- a/src/modules/lost/response.c
+++ b/src/modules/lost/response.c
@@ -1006,8 +1006,8 @@ p_lost_fsr_t lost_parse_findServiceResponse(str ret)
  * lost_check_HeldResponse(node)
  * does a quick check of HELD dereference response and returns ...
  * 0: neither location value nor reference found
- * 1: location value found
- * 2: location reference found
+ * 1: location reference found
+ * 2: location value found
  * 3: location value and reference found
  * multiple occurences are ignored
  */