Browse code

lost: lost_held_dereference() documentation added and code comment corrected

Wolfgang Kampichler authored on 03/05/2021 09:00:41
Showing 2 changed files
... ...
@@ -429,9 +429,23 @@ xlog("L_INFO", "HELD locationRequest: Result code $var(res)\nUrl: $var(url)\n$va
429 429
                     </para></listitem>
430 430
 			    </itemizedlist>
431 431
 			<para>
432
-			The return value is 200 on success, 400 if an internal error occured, or 500 if an
433
-            error code is returned in the HELD response.
432
+			The return value is 200..203 on success, 400 if an internal error occured, or 500 if an
433
+            error code is returned in the HELD response. Success codes in detail are as follows:
434 434
 	    	</para>
435
+			<itemizedlist>
436
+                <listitem><para>
437
+                    <emphasis>200</emphasis> - received 200 OK, but neither location-info nor locationURI element found
438
+                </para></listitem>
439
+                <listitem><para>
440
+                    <emphasis>201</emphasis> - received 200 OK with locationURI (aka Location-by-Reference)
441
+                </para></listitem>
442
+                <listitem><para>
443
+                    <emphasis>202</emphasis> - received 200 OK with location-info element (aka Location-by-Value)
444
+                </para></listitem>
445
+                <listitem><para>
446
+                    <emphasis>203</emphasis> - received 200 OK with location-info and locationURI element
447
+                </para></listitem>
448
+            </itemizedlist>            
435 449
 			<para>
436 450
 			This function can be used from REQUEST_ROUTE,
437 451
 			ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE.
... ...
@@ -1006,8 +1006,8 @@ p_lost_fsr_t lost_parse_findServiceResponse(str ret)
1006 1006
  * lost_check_HeldResponse(node)
1007 1007
  * does a quick check of HELD dereference response and returns ...
1008 1008
  * 0: neither location value nor reference found
1009
- * 1: location value found
1010
- * 2: location reference found
1009
+ * 1: location reference found
1010
+ * 2: location value found
1011 1011
  * 3: location value and reference found
1012 1012
  * multiple occurences are ignored
1013 1013
  */