diff --git a/modules/proto_hep/README b/modules/proto_hep/README
index e80b521a26c..0fbe1f7b88b 100644
--- a/modules/proto_hep/README
+++ b/modules/proto_hep/README
@@ -24,10 +24,9 @@ Ionut-Razvan Ionita
1.3.3. hep_max_msg_chunks (integer)
1.3.4. hep_async (integer)
1.3.5. hep_async_max_postponed_chunks (integer)
- 1.3.6. hep_version (integer)
- 1.3.7. hep_capture_id (integer)
- 1.3.8. hep_async_local_connect_timeout (integer)
- 1.3.9. hep_async_local_write_timeout (integer)
+ 1.3.6. hep_capture_id (integer)
+ 1.3.7. hep_async_local_connect_timeout (integer)
+ 1.3.8. hep_async_local_write_timeout (integer)
2. Developer Guide
@@ -46,10 +45,9 @@ Ionut-Razvan Ionita
1.3. Set hep_max_msg_chunks parameter
1.4. Set hep_async parameter
1.5. Set hep_async_max_postponed_chunks parameter
- 1.6. Set hep_version parameter
- 1.7. Set hep_capture_id parameter
- 1.8. Set hep_async_local_connect_timeout parameter
- 1.9. Set hep_async_local_write_timeout parameter
+ 1.6. Set hep_capture_id parameter
+ 1.7. Set hep_async_local_connect_timeout parameter
+ 1.8. Set hep_async_local_write_timeout parameter
Chapter 1. Admin Guide
@@ -64,11 +62,17 @@ Chapter 1. Admin Guide
Once loaded, you will be able to define HEP listeners in your
configuration file by adding their IP and, optionally, a
- listening port, similar to this example:
+ listening port. You can define both TCP and UDP listeners. On
+ UDP you will be able to receive HEP v1, v2 and v3 packets, on
+ TCP only HEPv3.
...
-listen = hep:127.0.0.1 # change the listening IP
-listen = hep:127.0.0.1:5080 # change the listening IP and port
+#HEPv3 listener
+listen = hep_tcp:127.0.0.1:6061 # change the listening I
+P
+#HEPv1, v2, v3 listener
+listen = hep_udp:127.0.0.1:6061 # change the listening I
+P
...
1.2. Dependencies
@@ -154,33 +158,19 @@ modparam("proto_bin", "hep_async", 0)
modparam("proto_hep", "hep_async_max_postponed_chunks", 16)
...
-1.3.6. hep_version (integer)
-
- The parameter indicate the version of HEP protocol. Can be 1, 2
- or 3. In HEPv2 the timestamp and capture agent ID will be
- included to HEP header. Version 1 and 2 uses UDP and version 3
- uses TCP.
-
- Default value is "3".
-
- Example 1.6. Set hep_version parameter
-...
-modparam("proto_hep", "hep_version", 2)
-...
-
-1.3.7. hep_capture_id (integer)
+1.3.6. hep_capture_id (integer)
The parameter indicate the capture agent ID for HEPv2/v3
protocol. Limitation: 16-bit integer.
Default value is "1".
- Example 1.7. Set hep_capture_id parameter
+ Example 1.6. Set hep_capture_id parameter
...
modparam("proto_hep", "hep_capture_id", 234)
...
-1.3.8. hep_async_local_connect_timeout (integer)
+1.3.7. hep_async_local_connect_timeout (integer)
If hep_async is enabled, this specifies the number of
milliseconds that a connect will be tried in blocking mode
@@ -190,12 +180,12 @@ modparam("proto_hep", "hep_capture_id", 234)
Default value is 100 ms.
- Example 1.8. Set hep_async_local_connect_timeout parameter
+ Example 1.7. Set hep_async_local_connect_timeout parameter
...
modparam("proto_hep", "hep_async_local_connect_timeout", 200)
...
-1.3.9. hep_async_local_write_timeout (integer)
+1.3.8. hep_async_local_write_timeout (integer)
If hep_async is enabled, this specifies the number of
milliseconds that a write op will be tried in blocking mode
@@ -205,7 +195,7 @@ modparam("proto_hep", "hep_async_local_connect_timeout", 200)
Default value is 10 ms.
- Example 1.9. Set hep_async_local_write_timeout parameter
+ Example 1.8. Set hep_async_local_write_timeout parameter
...
modparam("proto_hep", "tcp_async_local_write_timeout", 100)
...
diff --git a/modules/proto_hep/doc/proto_hep_admin.xml b/modules/proto_hep/doc/proto_hep_admin.xml
index 02a2cfc8c10..965880756ed 100644
--- a/modules/proto_hep/doc/proto_hep_admin.xml
+++ b/modules/proto_hep/doc/proto_hep_admin.xml
@@ -16,13 +16,16 @@
Once loaded, you will be able to define HEP listeners in your
- configuration file by adding their IP and, optionally, a listening port,
- similar to this example:
+ configuration file by adding their IP and, optionally, a listening port.
+ You can define both TCP and UDP listeners. On UDP you will be able to
+ receive HEP v1, v2 and v3 packets, on TCP only HEPv3.
...
-listen = hep:127.0.0.1 # change the listening IP
-listen = hep:127.0.0.1:5080 # change the listening IP and port
+#HEPv3 listener
+listen = hep_tcp:127.0.0.1:6061 # change the listening IP
+#HEPv1, v2, v3 listener
+listen = hep_udp:127.0.0.1:6061 # change the listening IP
...
diff --git a/modules/sipcapture/README b/modules/sipcapture/README
index 64b7979ef34..0dc5fa9c35d 100644
--- a/modules/sipcapture/README
+++ b/modules/sipcapture/README
@@ -562,7 +562,9 @@ hep_del("25"); /* removes chunk with chunk id 25 */
Relay a message statefully to destination indicated in current
URI. (If the original URI was rewritten by UsrLoc, RR,
strip/prefix, etc., the new URI will be taken). The message has
- to have been a HEP message, version 1, 2 or 3.
+ to have been a HEP message, version 1, 2 or 3. For version 1
+ and 2 you can relay only using UDP, for version 3 TCP and UDP
+ can be used.
This function can be used from
REQUEST_ROUTE,FAILURE_ROUTE,ONREPLY_ROUTE,BRANCH_ROUTE,LOCAL_RO
diff --git a/modules/sipcapture/doc/sipcapture_admin.xml b/modules/sipcapture/doc/sipcapture_admin.xml
index 0582230f837..923afbfd2c5 100644
--- a/modules/sipcapture/doc/sipcapture_admin.xml
+++ b/modules/sipcapture/doc/sipcapture_admin.xml
@@ -818,7 +818,8 @@ hep_del("25"); /* removes chunk with chunk id 25 */
Relay a message statefully to destination indicated in current URI.
(If the original URI was rewritten by UsrLoc, RR, strip/prefix, etc.,
the new URI will be taken). The message has to have been a HEP message,
- version 1, 2 or 3.
+ version 1, 2 or 3. For version 1 and 2 you can relay only using UDP,
+ for version 3 TCP and UDP can be used.
This function can be used from REQUEST_ROUTE,FAILURE_ROUTE,ONREPLY_ROUTE,BRANCH_ROUTE,LOCAL_ROUTE.
diff --git a/modules/siptrace/README b/modules/siptrace/README
index b5f1cf7e8a3..bdc2548fb97 100644
--- a/modules/siptrace/README
+++ b/modules/siptrace/README
@@ -162,7 +162,10 @@ modparam("siptrace", "trace_local_ip", "10.1.1.1")
All the old parameter such as db_url, table and duplicate_uri
will form the trace id with the name "default".
- No default value. If not set the module will be useless.
+ No default value. If not set the module will be useless. For
+ HEP ids, if transport parameter is not set default will be TCP
+ for version 3 and UDP for 1 and 2. Also if version not set,
+ version 3 will be used by default.
Example 1.3. Set trace_id parameter
...
@@ -181,6 +184,16 @@ modparam("siptrace", "trace_id",
* meaning that calling sip_trace("tid",...)
* will do sql, sip and hep tracing */
+/* hep version 3 with tcp - ALSO DEFAULT ONE */
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;transport=tcp;version=3")
+/* hep version 3 with udp (version not set-default will be 3)*/
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;transport=udp")
+/* hep version 1 */
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;version=1")
+
...
1.4. Exported Functions
diff --git a/modules/siptrace/doc/siptrace_admin.xml b/modules/siptrace/doc/siptrace_admin.xml
index 4c8c3d7dd62..d8f2ec729c4 100644
--- a/modules/siptrace/doc/siptrace_admin.xml
+++ b/modules/siptrace/doc/siptrace_admin.xml
@@ -176,6 +176,9 @@ modparam("siptrace", "trace_local_ip", "10.1.1.1")
No default value. If not set the module will be useless.
+ For HEP ids, if transport parameter is not set default will
+ be TCP for version 3 and UDP for 1 and 2. Also if version
+ not set, version 3 will be used by default.
@@ -197,6 +200,16 @@ modparam("siptrace", "trace_id",
* meaning that calling sip_trace("tid",...)
* will do sql, sip and hep tracing */
+/* hep version 3 with tcp - ALSO DEFAULT ONE */
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;transport=tcp;version=3")
+/* hep version 3 with udp (version not set-default will be 3)*/
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;transport=udp")
+/* hep version 1 */
+modparam("siptrace", "trace_id",
+"[tid]uri=hep:10.10.10.12:5061;version=1")
+
...