From 05713c36eac3f32f2a9a268c7ac87d19ca6896ca Mon Sep 17 00:00:00 2001
From: Matt Jordan <mjordan@digium.com>
Date: Tue, 14 Mar 2017 09:55:06 -0500
Subject: [PATCH] configs/samples/hep.conf.sample: Clarify how the HEP stack
works
This patch updates the documenation in hep.conf.sample to better specify
how the various HEP modules interact.
ASTERISK-26717 #close
Change-Id: I337fb742a89e3ec5edc7fc7a7a0295218d841124
---
configs/samples/hep.conf.sample | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/configs/samples/hep.conf.sample b/configs/samples/hep.conf.sample
index e1cd52ebb0..3d1e741399 100644
--- a/configs/samples/hep.conf.sample
+++ b/configs/samples/hep.conf.sample
@@ -2,6 +2,15 @@
; res_hep Module configuration for Asterisk
;
+;
+; Note that this configuration file is consumed by res_hep, which is responsible
+; for the HEPv3 protocol manipulation and managing the connection to the Homer
+; capture server. Additional modules provide specific messages to be sent to
+; the Homer server:
+; - res_hep_pjsip: Send SIP messages transmitted/received by the PJSIP stack
+; - res_hep_rtcp: Send RTCP information (all channels)
+;
+
; All settings are currently set in the general section.
[general]
enabled = no ; Enable/disable forwarding of packets to a
@@ -17,4 +26,3 @@ uuid_type = call-id ; Specify the preferred source for the Homer
; correlation UUID. Valid options are:
; - 'call-id' for the PJSIP SIP Call-ID
; - 'channel' for the Asterisk channel name
-
--
GitLab