comparison xml/en/docs/http/ngx_http_core_module.xml @ 172:5e8e63f73c33

Documented "lingering_close", "lingering_time", and "lingering_timeout".
author Ruslan Ermilov <ru@nginx.com>
date Thu, 03 Nov 2011 21:44:34 +0000
parents 6eeaa9e1f3b5
children 6b81a1950ecb
comparison
equal deleted inserted replaced
171:6eeaa9e1f3b5 172:5e8e63f73c33
815 flv; 815 flv;
816 limit_rate_after 500k; 816 limit_rate_after 500k;
817 limit_rate 50k; 817 limit_rate 50k;
818 } 818 }
819 </example> 819 </example>
820 </para>
821
822 </directive>
823
824
825 <directive name="lingering_close">
826 <syntax><value>off</value> | <value>on</value> | <value>always</value></syntax>
827 <default>on</default>
828 <context>http</context>
829 <context>server</context>
830 <context>location</context>
831 <appeared-in>1.1.0</appeared-in>
832 <appeared-in>1.0.6</appeared-in>
833
834 <para>
835 Controls how nginx closes client connections.
836 </para>
837
838 <para>
839 The default value “<value>on</value>” instructs nginx to
840 <link id="lingering_timeout">wait for</link> and
841 <link id="lingering_time">process</link> additional data from a client
842 before fully closing a connection, but only
843 if heuristics suggests that a client may be sending more data.
844 </para>
845
846 <para>
847 The value “<value>always</value>” will cause nginx to unconditionally
848 wait for and process additional client data.
849 </para>
850
851 <para>
852 The value “<value>off</value>” tells nginx to never wait for
853 more data and close the connection immediately.
854 This breaks the protocol and should not be used under normal circumstances.
855 </para>
856
857 </directive>
858
859
860 <directive name="lingering_time">
861 <syntax><argument>time</argument></syntax>
862 <default>30s</default>
863 <context>http</context>
864 <context>server</context>
865 <context>location</context>
866
867 <para>
868 When <link id="lingering_close"/> is in effect,
869 this directive specifies a maximum time during which nginx
870 will process (read and ignore) additional data coming from a client.
871 After that, the connection is closed, even if there are more data.
872 </para>
873
874 </directive>
875
876
877 <directive name="lingering_timeout">
878 <syntax><argument>time</argument></syntax>
879 <default>5s</default>
880 <context>http</context>
881 <context>server</context>
882 <context>location</context>
883
884 <para>
885 When <link id="lingering_close"/> is in effect, this directive specifies
886 a maximum waiting time for more client data to arrive.
887 If data are not received during this time, the connection is closed.
888 Otherwise, data are read and ignored, then nginx waits again for more data.
889 The “wait-read-ignore” cycle is repeated, but no longer than specified by the
890 <link id="lingering_time"/> directive.
820 </para> 891 </para>
821 892
822 </directive> 893 </directive>
823 894
824 895