Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_core_module.xml @ 223:09b8c8b2b865
Documented the "so_keepalive" parameter of the "listen" directive.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Tue, 06 Dec 2011 07:19:07 +0000 |
parents | 05e7496801ec |
children | 46ef98b7513f |
comparison
equal
deleted
inserted
replaced
222:bfe3eff81d04 | 223:09b8c8b2b865 |
---|---|
926 [<parameter>accept_filter</parameter>=<argument>filter</argument>] | 926 [<parameter>accept_filter</parameter>=<argument>filter</argument>] |
927 [<parameter>deferred</parameter>] | 927 [<parameter>deferred</parameter>] |
928 [<parameter>bind</parameter>] | 928 [<parameter>bind</parameter>] |
929 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] | 929 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] |
930 [<parameter>ssl</parameter>] | 930 [<parameter>ssl</parameter>] |
931 </syntax> | 931 [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> |
932 <syntax> | 932 <syntax> |
933 <argument>port</argument> | 933 <argument>port</argument> |
934 [<parameter>default_server</parameter>] | 934 [<parameter>default_server</parameter>] |
935 [<parameter>setfib</parameter>=<argument>number</argument>] | 935 [<parameter>setfib</parameter>=<argument>number</argument>] |
936 [<parameter>backlog</parameter>=<argument>number</argument>] | 936 [<parameter>backlog</parameter>=<argument>number</argument>] |
939 [<parameter>accept_filter</parameter>=<argument>filter</argument>] | 939 [<parameter>accept_filter</parameter>=<argument>filter</argument>] |
940 [<parameter>deferred</parameter>] | 940 [<parameter>deferred</parameter>] |
941 [<parameter>bind</parameter>] | 941 [<parameter>bind</parameter>] |
942 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] | 942 [<parameter>ipv6only</parameter>=<value>on</value>|<value>off</value>] |
943 [<parameter>ssl</parameter>] | 943 [<parameter>ssl</parameter>] |
944 </syntax> | 944 [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> |
945 <syntax> | 945 <syntax> |
946 <value>unix:</value><argument>path</argument> | 946 <value>unix:</value><argument>path</argument> |
947 [<parameter>default_server</parameter>] | 947 [<parameter>default_server</parameter>] |
948 [<parameter>backlog</parameter>=<argument>number</argument>] | 948 [<parameter>backlog</parameter>=<argument>number</argument>] |
949 [<parameter>rcvbuf</parameter>=<argument>size</argument>] | 949 [<parameter>rcvbuf</parameter>=<argument>size</argument>] |
950 [<parameter>sndbuf</parameter>=<argument>size</argument>] | 950 [<parameter>sndbuf</parameter>=<argument>size</argument>] |
951 [<parameter>accept_filter</parameter>=<argument>filter</argument>] | 951 [<parameter>accept_filter</parameter>=<argument>filter</argument>] |
952 [<parameter>deferred</parameter>] | 952 [<parameter>deferred</parameter>] |
953 [<parameter>bind</parameter>] | 953 [<parameter>bind</parameter>] |
954 [<parameter>ssl</parameter>] | 954 [<parameter>ssl</parameter>] |
955 </syntax> | 955 [<parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>]]</syntax> |
956 <default>*:80 | *:8000</default> | 956 <default>*:80 | *:8000</default> |
957 <context>server</context> | 957 <context>server</context> |
958 | 958 |
959 <para> | 959 <para> |
960 Sets an <argument>address</argument> and a <argument>port</argument> for IP, | 960 Sets an <argument>address</argument> and a <argument>port</argument> for IP, |
1085 for the given port (<code>*</code>:<argument>port</argument>). | 1085 for the given port (<code>*</code>:<argument>port</argument>). |
1086 It should be noted that in this case a <c-func>getsockname</c-func> | 1086 It should be noted that in this case a <c-func>getsockname</c-func> |
1087 system call will be made to determine an address that accepted a | 1087 system call will be made to determine an address that accepted a |
1088 connection. | 1088 connection. |
1089 If parameters <parameter>backlog</parameter>, <parameter>rcvbuf</parameter>, | 1089 If parameters <parameter>backlog</parameter>, <parameter>rcvbuf</parameter>, |
1090 <parameter>sndbuf</parameter>, <parameter>accept_filter</parameter>, or | 1090 <parameter>sndbuf</parameter>, <parameter>accept_filter</parameter>, |
1091 <parameter>deferred</parameter> are used then for a given | 1091 <parameter>deferred</parameter>, or <parameter>so_keepalive</parameter> |
1092 are used then for a given | |
1092 <argument>address</argument>:<argument>port</argument> pair | 1093 <argument>address</argument>:<argument>port</argument> pair |
1093 a separate <c-func>bind</c-func> call will always be made. | 1094 a separate <c-func>bind</c-func> call will always be made. |
1094 </tag-desc> | 1095 </tag-desc> |
1095 | 1096 |
1096 <tag-name> | 1097 <tag-name> |
1114 in both HTTP and HTTPS modes simultaneously. | 1115 in both HTTP and HTTPS modes simultaneously. |
1115 <example> | 1116 <example> |
1116 listen 80; | 1117 listen 80; |
1117 listen 443 default ssl; | 1118 listen 443 default ssl; |
1118 </example> | 1119 </example> |
1120 </tag-desc> | |
1121 | |
1122 <tag-name> | |
1123 <parameter>so_keepalive</parameter>=<value>on</value>|<value>off</value>|[<argument>keepidle</argument>]:[<argument>keepintvl</argument>]:[<argument>keepcnt</argument>] | |
1124 </tag-name> | |
1125 <tag-desc> | |
1126 this parameter (1.1.11) configures the “TCP keepalive” behavior | |
1127 for the listening socket. | |
1128 If this parameter is omitted then the system default setting will be | |
1129 in effect for the socket. | |
1130 If set to the value “<value>on</value>”, the <c-def>SO_KEEPALIVE</c-def> | |
1131 socket option is turned on for the socket. | |
1132 If set to the value “<value>off</value>”, the <c-def>SO_KEEPALIVE</c-def> | |
1133 socket option is turned off for the socket. | |
1134 Some operating systems support tuning TCP keepalive parameters on a per-socket | |
1135 basis using the <c-def>TCP_KEEPIDLE</c-def>, <c-def>TCP_KEEPINTVL</c-def>, | |
1136 and <c-def>TCP_KEEPCNT</c-def> socket options. | |
1137 On such systems (currently, Linux 2.4+ and NetBSD 5+) they can be configured | |
1138 using the <argument>keepidle</argument>, <argument>keepintvl</argument>, and | |
1139 <argument>keepcnt</argument> arguments. | |
1140 One or two arguments may be omitted, in which case the system default setting | |
1141 for the corresponding socket option will be in effect. | |
1142 For example, | |
1143 <example>so_keepalive=30m::10</example> | |
1144 will set idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes, | |
1145 leave probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default, | |
1146 and set probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes. | |
1119 </tag-desc> | 1147 </tag-desc> |
1120 | 1148 |
1121 </list> | 1149 </list> |
1122 </para> | 1150 </para> |
1123 | 1151 |