annotate xml/en/docs/events.xml @ 2956:a85e4d126bc7

Updated docs for the upcoming NGINX Plus release.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 02 May 2023 11:39:21 +0100
parents 7e983e0199eb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 563
diff changeset
1 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 563
diff changeset
2 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 563
diff changeset
3 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 563
diff changeset
4 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 563
diff changeset
5
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6 <!DOCTYPE article SYSTEM "../../../dtd/article.dtd">
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8 <article name="Connection processing methods"
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
9 link="/en/docs/events.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
10 lang="en"
1941
7e983e0199eb Added note about eventport method stability.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
11 rev="6">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
12
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13 <section>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 nginx supports a variety of connection processing methods.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
17 The availability of a particular method depends on the platform used.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
18 On platforms that support several methods nginx will normally
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 select the most efficient method automatically.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20 However, if needed, a connection processing method can be selected
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 explicitly with the
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22 <link doc="ngx_core_module.xml" id="use"/> directive.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
23 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 The following connection processing methods are supported:
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <list type="bullet">
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
28
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
29 <listitem id="select">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
30 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
31 <literal>select</literal>&mdash;standard method.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32 The supporting module is built automatically on platforms that lack
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
33 more efficient methods.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
34 The <literal>--with-select_module</literal> and
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
35 <literal>--without-select_module</literal> configuration parameters
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
36 can be used to forcibly enable or disable the build of this module.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
37 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
38 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
39
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
40 <listitem id="poll">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
41 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
42 <literal>poll</literal>&mdash;standard method.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 The supporting module is built automatically on platforms that lack
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 more efficient methods.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 The <literal>--with-poll_module</literal> and
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46 <literal>--without-poll_module</literal> configuration parameters
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 can be used to forcibly enable or disable the build of this module.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
51 <listitem id="kqueue">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
52 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
53 <literal>kqueue</literal>&mdash;efficient method used on
1911
f024ac0ec5c7 Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents: 1784
diff changeset
54 FreeBSD 4.1+, OpenBSD 2.9+, NetBSD 2.0, and macOS.
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
55 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
56 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
57
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
58 <listitem id="epoll">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
59 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
60 <literal>epoll</literal>&mdash;efficient method used on
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
61 Linux 2.6+.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
62 <note>
1784
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1465
diff changeset
63 The <literal>EPOLLRDHUP</literal> (Linux 2.6.17, glibc 2.8)
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1465
diff changeset
64 and <literal>EPOLLEXCLUSIVE</literal> (Linux 4.5, glibc 2.24)
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1465
diff changeset
65 flags are supported since 1.11.3.
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1465
diff changeset
66 </note>
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1465
diff changeset
67 <note>
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
68 Some older distributions like SuSEĀ 8.2 provide patches
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
69 that add epoll support to 2.4 kernels.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
70 </note>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
71 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
72 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
73
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
74 <listitem id="devpoll">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
75 <para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
76 <literal>/dev/poll</literal>&mdash;efficient method used on
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
77 Solaris 7 11/99+, HP/UX 11.22+ (eventport), IRIX 6.5.15+,
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
78 and Tru64 UNIX 5.1A+.
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
79 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
80 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
81
755
629630df119a Added anchors to event processing methods.
Ruslan Ermilov <ru@nginx.com>
parents: 659
diff changeset
82 <listitem id="eventport">
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
83 <para>
1941
7e983e0199eb Added note about eventport method stability.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
84 <literal>eventport</literal>&mdash;event ports, method
7e983e0199eb Added note about eventport method stability.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
85 used on Solaris 10+ (due to known issues,
7e983e0199eb Added note about eventport method stability.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1911
diff changeset
86 it is recommended using the <literal>/dev/poll</literal> method instead).
553
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
87 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 </listitem>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 </list>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 </para>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93 </section>
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94
6330ca27a485 Translated "events" into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 </article>