[sr-dev] git:master:345bbbe2: modules/siputils: document P-Charging-Vector related pseudo variables

[Mikko Lehto]

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

Author: Mikko Lehto <mslehto at iki.fi>
Committer: Mikko Lehto <mslehto at iki.fi>
Date: 2016-11-07T01:49:08+02:00

modules/siputils: document P-Charging-Vector related pseudo variables

---

Modified: modules/siputils/chargingvector.h
Modified: modules/siputils/doc/siputils_admin.xml

---

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

---

diff --git a/modules/siputils/chargingvector.h b/modules/siputils/chargingvector.h
index c171672..cb7ef81 100644
--- a/modules/siputils/chargingvector.h
+++ b/modules/siputils/chargingvector.h
@@ -19,19 +19,22 @@
  */
 
 /*
- * Support for rfc3455 P-Charging-Vector
+ * Support for RFC3455 / RFC7315 P-Charging-Vector
  * - parse charging vector from SIP message
  * - generate new unique charging vector
  * - can remove charging vector
  *
- * pseudo variables are exported and enable R ondly access to charging vector fields
+ * pseudo variables are exported and enable read only access to charging vector fields
  * $pcv(all) = whole field
  * $pcv(value) = icid-value field (see RFC3455 section 5.6)
  * $pcv(genaddr) = icid-generated-at field (see RFC3455 section 5.6)
+ * $pcv(orig) = orig-ioi field (see RFC3455 section 5.6)
+ * $pcv(term) = term-ioi field (see RFC3455 section 5.6)
  *
- * to be supported
- * $pcv(orig)
- * $pcv(term)
+ * missing:
+ * $pcv(transit-ioi) RFC7315 5.6
+ * $pcv(related-icid) RFC7315 5.6
+ * $pcv(related-icid-gen-addr) RFC7315 5.6
  */
 
 #ifndef _CHARGINGVECTOR_H_
diff --git a/modules/siputils/doc/siputils_admin.xml b/modules/siputils/doc/siputils_admin.xml
index 208ee3a..ccca958 100644
--- a/modules/siputils/doc/siputils_admin.xml
+++ b/modules/siputils/doc/siputils_admin.xml
@@ -1066,7 +1066,7 @@ if(is_first_hop()) { ... }
 			<function moreinfo="none">sip_p_charging_vector(flags)</function>
 		</title>
 		<para>
-			Manage the P-Charging-Vector header (RFC3455). The flags can be:
+			Manage the P-Charging-Vector header (RFC7315). The flags can be:
 			'r' - remove; 'g' - generate; 'f' - force (remove + generate).
 		</para>
 		<para>
@@ -1083,4 +1083,34 @@ sip_p_charging_vector("g");
 	</section>
 	</section>
 
+	<section>
+			<title>Exported pseudo-variables</title>
+			<section id="siputils.v.pcv_all">
+					<title><varname>$pcv(all)</title>
+					<para>
+						full P-Charging-Vector header
+					</para>
+			<section id="siputils.v.pcv_value">
+					<title><varname>$pcv(value)</title>
+					<para>
+						icid-value field (see RFC7315 section 5.6)
+					</para>
+			<section id="siputils.v.pcv_genaddr">
+					<title><varname>$pcv(genaddr)</title>
+					<para>
+						icid-generated-at field (see RFC7315 section 5.6)
+					</para>
+			<section id="siputils.v.pcv_orig">
+					<title><varname>$pcv(orig)</title>
+					<para>
+						orig-ioi field (see RFC7315 section 5.6)
+					</para>
+			<section id="siputils.v.pcv_term">
+					<title><varname>$pcv(term)</title>
+					<para>
+						term-ioi field (see RFC7315 section 5.6)
+					</para>
+			</section>
+	<section>
+
 </chapter>