changeset 553:6330ca27a485

Translated "events" into English.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 26 Jun 2012 07:36:58 +0000
parents 32bde52db92c
children ccb7451af1d8
files xml/en/GNUmakefile xml/en/docs/events.xml xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/index.xml xml/en/docs/windows.xml xml/en/index.xml
diffstat 6 files changed, 123 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/GNUmakefile
+++ b/xml/en/GNUmakefile
@@ -6,6 +6,7 @@ DOCS =									\
 		faq							\
 		install							\
 		windows							\
+		events							\
 		control							\
 		hash							\
 		dirindex						\
new file mode 100644
--- /dev/null
+++ b/xml/en/docs/events.xml
@@ -0,0 +1,112 @@
+<!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
+
+<article name="Connection processing methods"
+         link="/en/docs/events.html"
+         lang="en">
+
+<section>
+
+<para>
+nginx supports a variety of connection processing methods.
+The availability of a particular method depends on the platform used.
+On platforms that support several methods nginx will normally
+select the most efficient method automatically.
+However, if needed, a connection processing method can be selected
+explicitly with the
+<link doc="ngx_core_module.xml" id="use"/> directive.
+</para>
+
+<para>
+The following connection processing methods are supported:
+<list type="bullet">
+
+<listitem>
+<para>
+<literal>select</literal>&mdash;standard method.
+The supporting module is built automatically on platforms that lack
+more efficient methods.
+The <literal>--with-select_module</literal> and
+<literal>--without-select_module</literal> configuration parameters
+can be used to forcibly enable or disable the build of this module.
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>poll</literal>&mdash;standard method.
+The supporting module is built automatically on platforms that lack
+more efficient methods.
+The <literal>--with-poll_module</literal> and
+<literal>--without-poll_module</literal> configuration parameters
+can be used to forcibly enable or disable the build of this module.
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>kqueue</literal>&mdash;efficient method used on
+FreeBSD 4.1+, OpenBSD 2.9+, NetBSD 2.0, and Mac OS X.
+<note>
+On two-processor machines running some older versions of Mac OS X
+the use of kqueue may cause a kernel panic.
+</note>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>epoll</literal>&mdash;efficient method used on
+Linux 2.6+.
+<note>
+Some older distributions like SuSEĀ 8.2 provide patches
+that add epoll support to 2.4 kernels.
+</note>
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>rtsig</literal>&mdash;real time signals, efficient method
+used on Linux 2.2.19+.
+By default,
+the system-wide event queue is limited by 1024 signals.
+On loaded servers it may become necessary to increase this limit
+by changing the <path>/proc/sys/kernel/rtsig-max</path> kernel parameter.
+However, in Linux 2.6.6-mm2 this parameter is gone, and each process
+now has its own event queue.
+The size of each queue is limited by <literal>RLIMIT_SIGPENDING</literal>.
+</para>
+
+<para>
+On queue overflow, nginx discards the queue and falls back to
+<literal>poll</literal> connection processing method until
+the situation gets back to normal.
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>/dev/poll</literal>&mdash;efficient method used on
+Solaris 7 11/99+, HP/UX 11.22+ (eventport), IRIX 6.5.15+,
+and Tru64 UNIX 5.1A+.
+</para>
+</listitem>
+
+<listitem>
+<para>
+<literal>eventport</literal>&mdash;event ports, efficient method
+used on Solaris 10.
+<note>
+This
+<link url="http://sunsolve.sun.com/search/document.do?assetkey=1-26-102485-1">patch</link>
+might be required to avoid kernel panics.
+</note>
+</para>
+</listitem>
+
+</list>
+</para>
+
+</section>
+
+</article>
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -1983,8 +1983,8 @@ parameter of the <link id="satisfy"/> di
 <para>
 If set to a non-zero value, nginx will try to minimize the number
 of send operations on client sockets by using either
-<c-def>NOTE_LOWAT</c-def> flag of
-<link doc="../events.xml" id="kqueue"/>,
+<c-def>NOTE_LOWAT</c-def> flag of the
+<link doc="../events.xml" id="kqueue"/> method,
 or the <c-def>SO_SNDLOWAT</c-def> socket option,
 with the specified <value>size</value>.
 </para>
--- a/xml/en/docs/index.xml
+++ b/xml/en/docs/index.xml
@@ -37,6 +37,10 @@
 </listitem>
 
 <listitem>
+<link doc="events.xml"/>
+</listitem>
+
+<listitem>
 <link doc="control.xml"/>
 </listitem>
 
--- a/xml/en/docs/windows.xml
+++ b/xml/en/docs/windows.xml
@@ -9,7 +9,7 @@
 <para>
 Version of nginx for Windows uses the native Win32 API (not the Cygwin emulation
 layer).
-Only the <c-func>select</c-func> request processing method is currently used,
+Only the <c-func>select</c-func> connection processing method is currently used,
 so high performance and scalability should not be expected.
 Due to this and some other known issues version of nginx for Windows
 is considered to be a <i>beta</i> version.
@@ -138,7 +138,7 @@ Running as a service.
 </listitem>
 
 <listitem>
-Using the I/O completion ports as a request processing method.
+Using the I/O completion ports as a connection processing method.
 </listitem>
 
 <listitem>
--- a/xml/en/index.xml
+++ b/xml/en/index.xml
@@ -250,7 +250,8 @@ worker processes run under an unprivileg
 </listitem>
 
 <listitem>
-The notification methods: kqueue (FreeBSD 4.1+),
+<link doc="docs/events.xml">Support</link> for
+kqueue (FreeBSD 4.1+),
 epoll (Linux 2.6+), rt signals (Linux 2.2.19+),
 /dev/poll (Solaris 7 11/99+), event ports (Solaris 10),
 select, and poll;