[sipcapture] updated docs for HEPVERSION

OpenSIPS · May 3, 2016 · 090525c · 090525c
1 parent e547ec6
commit 090525c
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/modules/sipcapture/README b/modules/sipcapture/README
@@ -64,6 +64,7 @@ Alexandr Dubovikov
         1.6. Exported PseudoVariables
 
               1.6.1. hep_net
+              1.6.2. HEPVERSION - string,int
 
         1.7. MI Commands
 
@@ -98,6 +99,7 @@ Alexandr Dubovikov
    1.22. hep_resume_sip usage
    1.23. sip_capture usage
    1.24. hep_net usage
+   1.25. HEPVERSION usage
 
 Chapter 1. Admin Guide
 
@@ -659,6 +661,24 @@ route[capture_resume] {
         }
 ...
 
+1.6.2.  HEPVERSION - string,int
+
+   Holds the version of the hep packet received on the interface.
+
+   Example 1.25. HEPVERSION usage
+...
+        if ($HEPVERSION == 3) {
+                /* It's a HEPv3 packet*/
+                ...
+        } else if ($HEPVERSION == 2) {
+                /* It's a HEPv2 packet */
+                ...
+        } else if ($HEPVERSION == 1) {
+                /* It's a HEPv1 packet */
+                ...
+        }
+...
+
 1.7. MI Commands
 
 1.7.1.  sip_capture

diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml
@@ -965,6 +965,35 @@ route[capture_resume] {
 	</example>
 	</section>
 
+	<section>
+	<title>
+		<function moreinfo="none">HEPVERSION - string,int</function>
+	</title>
+	<para>
+		Holds the version of the hep packet received on the interface.
+	</para>
+	<example>
+	<title><function>HEPVERSION</function> usage</title>
+	<programlisting format="linespecific">
+...
+	if ($HEPVERSION == 3) {
+		/* It's a HEPv3 packet*/
+		...
+	} else if ($HEPVERSION == 2) {
+		/* It's a HEPv2 packet */
+		...
+	} else if ($HEPVERSION == 1) {
+		/* It's a HEPv1 packet */
+		...
+	}
+...
+	</programlisting>
+	</example>
+	</section>
+
+
+
+