[sr-dev] git:master:f1cf7f99: uac: documentation of flags returned via rpc command

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-01-20T09:10:22+01:00

uac: documentation of flags returned via rpc command

---

Modified: modules/uac/doc/uac_admin.xml

---

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

---

diff --git a/modules/uac/doc/uac_admin.xml b/modules/uac/doc/uac_admin.xml
index 3e6021f..dc95ec8 100644
--- a/modules/uac/doc/uac_admin.xml
+++ b/modules/uac/doc/uac_admin.xml
@@ -899,6 +899,27 @@ event_route[uac:reply] {
 			The value is what should be matcheg against the value of the attribute
 			in the remote registration record.
 		</para>
+		<para>
+			The state of the registration is reflected in the flags field:
+			<itemizedlist>
+			<listitem><para>
+			1 (2^0) - registration profile is disabled
+			</para></listitem>
+			<listitem><para>
+			2 (2^1) - registration in progress
+			</para></listitem>
+			<listitem><para>
+			4 (2^2) - registration succeeded
+			</para></listitem>
+			<listitem><para>
+			8 (2^3) - registration in progres with authentication
+			</para></listitem>
+			<listitem><para>
+			16 (2^4) - registration initialized (after loading from database,
+			the registration process was initialized)
+			</para></listitem>
+		</itemizedlist>
+		</para>
 		<example>
 		<title><function>uac.reg_info</function> usage</title>
 			<programlisting format="linespecific">