Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
Kamailio
/
kamailio
-ын хуулбар https://github.com/kamailio/kamailio.git
2
0
Салаа 0
Файлууд Асуудлууд 0 Мэдлэгийн сан
Эх сурвалжийг харах

gzcompress: added a small usage example in docs

Daniel-Constantin Mierla 12 жил өмнө
parent
3c65fd74f2
commit
65783f2485
2 өөрчлөгдсөн 134 нэмэгдсэн , 2 устгасан
Өөрчлөллтийг нэгтгэж харах Өөрчлөлтийн статистик харах
  1. 67 1
      modules/gzcompress/README
  2. 67 1
      modules/gzcompress/doc/gzcompress_admin.xml

+ 67 - 1
modules/gzcompress/README
Файл харах 

@@ -33,11 +33,14 @@ Daniel-Constantin Mierla
 
 
 
               4.1.
 
               4.1.
 
 
 
+        5. Config File
 
+
 
    List of Examples
 
    List of Examples
 
 
 
    1.1. Set header_name parameter
 
    1.1. Set header_name parameter
 
    1.2. Set header_value parameter
 
    1.2. Set header_value parameter
 
    1.3. Set sanity_checks parameter
 
    1.3. Set sanity_checks parameter
 
+   1.4. Enable body compression
 
 
 
 Chapter 1. Admin Guide
 
 Chapter 1. Admin Guide
 
 
 
@@ -59,11 +62,14 @@ Chapter 1. Admin Guide
 
 
 
         4.1.
 
         4.1.
 
 
 
+   5. Config File
 
+
 
 1. Overview
 
 1. Overview
 
 
 
    This module is able to detect compressed body in received SIP message
 
    This module is able to detect compressed body in received SIP message
 
    and decompress it as well as compress the body for outgoing SIP
 
    and decompress it as well as compress the body for outgoing SIP
 
-   message.
 
+   message. It works also for received HTTP request and replied HTTP
 
+   response (Kamailio cannot work in HTTP proxy mode).
 
 
 
    The decision of whether to do compression or decompression is made by
 
    The decision of whether to do compression or decompression is made by
 
    detecting a special SIP header (default 'Content-Encoding') that
 
    detecting a special SIP header (default 'Content-Encoding') that
 
@@ -160,3 +166,63 @@ modparam("gzcompress", "sanity_checks", 1)
 
    4.1.
 
    4.1.
 
 
 
    None.
 
    None.
 
+
 
+5. Config File
 
+
 
+   Next example shows how to enable compression for forwarded requests, as
 
+   well as replying with compressed body for HTTP requests. For SIP, the
 
+   request is recevied and forwarded to itself once, just for the sake of
 
+   showing a simple example.
 
+
 
+   Example 1.4. Enable body compression
 
+...
 
+
 
+#!KAMAILIO
 
+
 
+debug=3
 
+memdbg=5
 
+memlog=5
 
+
 
+children=2
 
+
 
+log_stderror=yes
 
+listen=udp:127.0.0.1:5060
 
+listen=tcp:127.0.0.1:5060
 
+
 
+tcp_accept_no_cl=yes
 
+http_reply_parse=yes
 
+
 
+mpath="modules/"
 
+
 
+loadmodule "sl.so"
 
+loadmodule "pv.so"
 
+loadmodule "xlog.so"
 
+loadmodule "corex.so"
 
+loadmodule "textops.so"
 
+loadmodule "xhttp.so"
 
+loadmodule "gzcompress.so"
 
+
 
+modparam("gzcompress", "header_value", "deflate")
 
+
 
+request_route {
 
+        xlog("received sip request from $si:$sp\r\n");
 
+
 
+        if(src_port==5060) {
 
+                remove_hf("Content-Encoding");
 
+                $du = "sip:127.0.0.1:9";
 
+        } else {
 
+                append_hf("Content-Encoding: gzip\r\n");
 
+                $du = "sip:127.0.0.1:5060";
 
+        }
 
+        forward();
 
+        exit;
 
+}
 
+
 
+event_route[xhttp:request] {
 
+        xlog("received http request from $si:$sp\r\n");
 
+        append_to_reply("Content-Encoding: deflate\r\n");
 
+    xhttp_reply("200", "OK", "text/html",
 
+        "<html><body>OK - [$si:$sp]</body></html>");
 
+}
 
+
 
+...

+ 67 - 1
modules/gzcompress/doc/gzcompress_admin.xml
Файл харах 

@@ -18,7 +18,8 @@
 
 	<para>
 
 	<para>
 
 		This module is able to detect compressed body in received SIP message
 
 		This module is able to detect compressed body in received SIP message
 
 		and decompress it as well as compress the body for outgoing SIP
 
 		and decompress it as well as compress the body for outgoing SIP
 
-		message.
 
+		message. It works also for received HTTP request and replied HTTP
 
+		response (&kamailio; cannot work in HTTP proxy mode).
 
 	</para>
 
 	</para>
 
 	<para>
 
 	<para>
 
 		The decision of whether to do compression or decompression is made
 
 		The decision of whether to do compression or decompression is made
 
@@ -161,5 +162,70 @@ modparam("gzcompress", "sanity_checks", 1)
 
 		</para>
 
 		</para>
 
 	</section>
 
 	</section>
 
 	</section>
 
 	</section>
 
+	<section>
 
+	<title>Config File</title>
 
+	<para>
 
+		Next example shows how to enable compression for forwarded requests,
 
+		as well as replying with compressed body for HTTP requests. For SIP,
 
+		the request is recevied and forwarded to itself once, just for the
 
+		sake of showing a simple example.
 
+	</para>
 
+		<example>
 
+		<title>Enable body compression</title>
 
+		<programlisting format="linespecific">
 
+...
 
+<![CDATA[
 
+#!KAMAILIO
 
+
 
+debug=3
 
+memdbg=5
 
+memlog=5
 
+
 
+children=2
 
+
 
+log_stderror=yes
 
+listen=udp:127.0.0.1:5060
 
+listen=tcp:127.0.0.1:5060
 
+
 
+tcp_accept_no_cl=yes
 
+http_reply_parse=yes
 
+
 
+mpath="modules/"
 
+
 
+loadmodule "sl.so"
 
+loadmodule "pv.so"
 
+loadmodule "xlog.so"
 
+loadmodule "corex.so"
 
+loadmodule "textops.so"
 
+loadmodule "xhttp.so"
 
+loadmodule "gzcompress.so"
 
+
 
+modparam("gzcompress", "header_value", "deflate")
 
+
 
+request_route {
 
+	xlog("received sip request from $si:$sp\r\n");
 
+
 
+	if(src_port==5060) {
 
+		remove_hf("Content-Encoding");
 
+		$du = "sip:127.0.0.1:9";
 
+	} else {
 
+		append_hf("Content-Encoding: gzip\r\n");
 
+		$du = "sip:127.0.0.1:5060";
 
+	}
 
+	forward();
 
+	exit;
 
+}
 
+
 
+event_route[xhttp:request] {
 
+	xlog("received http request from $si:$sp\r\n");
 
+	append_to_reply("Content-Encoding: deflate\r\n");
 
+    xhttp_reply("200", "OK", "text/html",
 
+        "<html><body>OK - [$si:$sp]</body></html>");
 
+}
 
+]]>
 
+...
 
+</programlisting>
 
+		</example>
 
+	</section>
 
 </chapter>
 
 </chapter>