[sr-dev] git:master:51f07e7b: registrar Clean up and document error codes from the unregister function

[Olle E. Johansson]

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

Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: 2016-05-11T14:03:59+02:00

registrar Clean up and document error codes from the unregister function

---

Modified: modules/registrar/README
Modified: modules/registrar/doc/registrar_admin.xml
Modified: modules/registrar/save.c

---

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

---

diff --git a/modules/registrar/README b/modules/registrar/README
index 104298f..6a42116 100644
--- a/modules/registrar/README
+++ b/modules/registrar/README
@@ -980,6 +980,12 @@ add_sock_hdr("Sock-Info");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
+   Return values:
+     * 0 - Successfully deleted contact(s)
+     * -1 - Failed to extract or parse address of record from argument
+     * -2 - Error in unregistering user
+     * -3 - Contacts for AOR not found
+
    Example 1.33. unregister usage
 ...
 unregister("location", "$ru");
diff --git a/modules/registrar/doc/registrar_admin.xml b/modules/registrar/doc/registrar_admin.xml
index 7cce1cf..054042f 100644
--- a/modules/registrar/doc/registrar_admin.xml
+++ b/modules/registrar/doc/registrar_admin.xml
@@ -1286,6 +1286,31 @@ add_sock_hdr("Sock-Info");
 		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 		</para>
+		<para>
+		Return values:
+		</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+			<emphasis>0</emphasis> - Successfully deleted contact(s)
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>-1</emphasis> - Failed to extract or parse address of record from argument
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>-2</emphasis> - Error in unregistering user
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>-3</emphasis> - Contacts for AOR not found
+			</para>
+		</listitem>
+		</itemizedlist>
 		<example>
 		<title><function>unregister</function> usage</title>
 		<programlisting format="linespecific">
diff --git a/modules/registrar/save.c b/modules/registrar/save.c
index 24b5d2a..996deb4 100644
--- a/modules/registrar/save.c
+++ b/modules/registrar/save.c
@@ -1011,6 +1011,12 @@ int save(struct sip_msg* _m, udomain_t* _d, int _cflags, str *_uri)
 	return 0;
 }
 
+/* Return values:
+	-1 Failed to extract or parse address of record from argument
+	-2 Error in unregistering user
+	-3 Contacts for AOR not found
+*/
+	
 int unregister(struct sip_msg* _m, udomain_t* _d, str* _uri, str *_ruid)
 {
 	str aor = {0, 0};
@@ -1028,13 +1034,15 @@ int unregister(struct sip_msg* _m, udomain_t* _d, str* _uri, str *_ruid)
 		}
 
 		u = parse_to_uri(_m);
-		if(u==NULL)
-			return -2;
+		if(u==NULL) {
+			LM_ERR("failed to extract Address Of Record\n");
+			return -1;
+		}
 
 		if (star(_m, _d, &aor, &u->host) < 0)
 		{
 			LM_ERR("error unregistering user [%.*s]\n", aor.len, aor.s);
-			return -1;
+			return -2;
 		}
 	} else {
 		/* ruid provided - remove a specific contact */
@@ -1049,12 +1057,12 @@ int unregister(struct sip_msg* _m, udomain_t* _d, str* _uri, str *_ruid)
 			if (ul.get_urecord_by_ruid(_d, ul.get_aorhash(&aor),
 						_ruid, &r, &c) != 0) {
 				LM_WARN("AOR/Contact not found\n");
-				return -1;
+				return -3;
 			}
 			if (ul.delete_ucontact(r, c) != 0) {
 				ul.unlock_udomain(_d, &aor);
 				LM_WARN("could not delete contact\n");
-				return -1;
+				return -2;
 			}
 			ul.unlock_udomain(_d, &aor);
 
@@ -1064,10 +1072,10 @@ int unregister(struct sip_msg* _m, udomain_t* _d, str* _uri, str *_ruid)
 			switch (res) {
 				case -1:
 					LM_ERR("could not delete contact\n");
-					return -1;
+					return -2;
 				case -2:
 					LM_WARN("contact not found\n");
-					return -1;
+					return -3;
 				default:
 					return 1;
 			}