[Asterisk-code-review] configs/samples/hep.conf.sample: Clarify how the HEP stack w... (asterisk[14])

[Joshua Colp]

Joshua Colp has submitted this change and it was merged. ( https://gerrit.asterisk.org/5187 )

Change subject: configs/samples/hep.conf.sample: Clarify how the HEP stack works
......................................................................


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
---
M configs/samples/hep.conf.sample
1 file changed, 9 insertions(+), 1 deletion(-)

Approvals:
  Kevin Harwell: Looks good to me, but someone else must approve
  Mark Michelson: Looks good to me, approved
  Anonymous Coward #1000019: Verified
  Joshua Colp: Looks good to me, but someone else must approve



diff --git a/configs/samples/hep.conf.sample b/configs/samples/hep.conf.sample
index e1cd52e..3d1e741 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 @@
                                    ; correlation UUID. Valid options are:
                                    ; - 'call-id' for the PJSIP SIP Call-ID
                                    ; - 'channel' for the Asterisk channel name
-

-- 
To view, visit https://gerrit.asterisk.org/5187
To unsubscribe, visit https://gerrit.asterisk.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I337fb742a89e3ec5edc7fc7a7a0295218d841124
Gerrit-PatchSet: 2
Gerrit-Project: asterisk
Gerrit-Branch: 14
Gerrit-Owner: Matt Jordan <mjordan at digium.com>
Gerrit-Reviewer: Anonymous Coward #1000019
Gerrit-Reviewer: Joshua Colp <jcolp at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-Reviewer: Mark Michelson <mmichelson at digium.com>