[sr-dev] git:master:7fd84903: sipdump: docs about mode flag 3 (write pcap) and notes about it

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 7fd849033ea6ad0485486bd5aec8130e03c13672
URL: https://github.com/kamailio/kamailio/commit/7fd849033ea6ad0485486bd5aec8130e03c13672

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-07-15T11:30:58+02:00

sipdump: docs about mode flag 3 (write pcap) and notes about it

---

Modified: src/modules/sipdump/doc/sipdump_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/7fd849033ea6ad0485486bd5aec8130e03c13672.diff
Patch: https://github.com/kamailio/kamailio/commit/7fd849033ea6ad0485486bd5aec8130e03c13672.patch

---

diff --git a/src/modules/sipdump/doc/sipdump_admin.xml b/src/modules/sipdump/doc/sipdump_admin.xml
index 0a603c2803..a02366528f 100644
--- a/src/modules/sipdump/doc/sipdump_admin.xml
+++ b/src/modules/sipdump/doc/sipdump_admin.xml
@@ -96,11 +96,12 @@ modparam("sipdump", "enable", 1)
 		<title><varname>mode</varname> (int)</title>
 		<para>
 			Set the type of activity done by the module, the value can be set
-			based on flags: 1 - write to files; 2 - execute event route
+			based on flags: 1 - write to text files; 2 - execute event route;
+			3 - write to pcap files
 		</para>
 		<para>
 		<emphasis>
-			Default value is 1 (write to files).
+			Default value is 1 (write to text files).
 		</emphasis>
 		</para>
 		<example>
@@ -173,7 +174,8 @@ modparam("sipdump", "folder", "/run/kamailio")
 		<title><varname>fprefix</varname> (str)</title>
 		<para>
 			File name prefix. The date is appended to this prefix in the format
-			yyyy-mm-dd--hh-mm-ss. The extension of the file is ".data".
+			yyyy-mm-dd--hh-mm-ss. The extension of the text file is ".data",
+			of the meta file is ".meta" and of the pcap file is ".pcap".
 		</para>
 		<para>
 		<emphasis>
@@ -320,6 +322,13 @@ route[TCLEAN] {
 }
 ...
 </programlisting>
+		<para>
+		If operational mode is set to write the pcap files, note that packets
+		in the pcap file are generated always with transport UDP, no matter
+		the SIP traffic was over another transport layer like TCP, TLS, SCTP
+		or WSS. The headers of the SIP message (e.g., Via, Route) should provide
+		hints about what the SIP transport layer.
+		</para>
 	</section>
 
 </chapter>