Преглед изворни кода

modules: readme files regenerated - sipdump ... [skip ci]

Kamailio Dev пре 5 година
родитељ
комит
fa7241c185
1 измењених фајлова са 14 додато и 3 уклоњено
  1. 14 3
      src/modules/sipdump/README

+ 14 - 3
src/modules/sipdump/README

@@ -154,9 +154,13 @@ modparam("sipdump", "enable", 1)
 3.2. mode (int)
 3.2. mode (int)
 
 
    Set the type of activity done by the module, the value can be set based
    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
+   on flags: 1 (value 1) - write to text files; 2 (value 2) - execute
+   event route; 3 (value 4) - write to pcap files.
 
 
-   Default value is 1 (write to files).
+   To enable several activity modes, set the parameter to the sum of
+   correspinding values.
+
+   Default value is 1 (write to text files).
 
 
    Example 1.2. Set mode parameter
    Example 1.2. Set mode parameter
 ...
 ...
@@ -199,7 +203,8 @@ modparam("sipdump", "folder", "/run/kamailio")
 3.6. fprefix (str)
 3.6. fprefix (str)
 
 
    File name prefix. The date is appended to this prefix in the format
    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".
 
 
    Default value is "kamailio-sipdump-".
    Default value is "kamailio-sipdump-".
 
 
@@ -299,3 +304,9 @@ route[TCLEAN] {
     exec_cmd("find /tmp -type f -name kamailio-sipdump-* -mtime +1 -delete &");
     exec_cmd("find /tmp -type f -name kamailio-sipdump-* -mtime +1 -delete &");
 }
 }
 ...
 ...
+
+   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.