<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="pike.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
    </sectioninfo>

    <title>Parameters</title>

    <section>
	    <title><varname>sampling_time_unit</varname> (integer)</title>
	<para>
	    Time period used for sampling (or the sampling accuracy ;-) ). The
	    smaller the better, but slower. If you want to detect peeks, use a
	    small one. To limit the access (like total number of requests on a
	    long period of time) to a proxy resource (a gateway for ex), use a
	    bigger value of this parameter.
	</para>
	<para>
	    Default value is 2.
	</para>
	<example>
	    <title>Set <varname>sampling_time_unit</varname> parameter</title>
	    <programlisting>
...
modparam("pike", "sampling_time_unit", 10)
...
	    </programlisting>
	</example>
    </section>

    <section id="reqs_density_per_unix">
	<title><varname>reqs_density_per_unit</varname> (integer)</title>
	<para>
	    How many requests should be allowed per sampling_time_unit before
	    blocking all the incoming request from that IP. Practically, the
	    blocking limit is between ( let's have x=reqs_density_per_unit) x
	    and 3*x for IPv4 addresses and between x and 8*x for ipv6
	    addresses.
	</para>
	<para>
	    Default value is 30.
	</para>
	<example>
	    <title>Set <varname>reqs_density_per_unit</varname> parameter</title>
	    <programlisting>
...
modparam("pike", "reqs_density_per_unit", 30)
...
	    </programlisting>
	</example>
    </section>

    <section id="remove_latency">
	<title><varname>remove_latency</varname> (integer)</title>
	<para>
	    For how long the IP address will be kept in memory after the last
	    request from that IP address. It's a sort of timeout value.
	</para>
	<para>
	    Default value is 120.
	</para>
	<example>
	    <title>Set <varname>remove_latency</varname> parameter</title>
	    <programlisting>
...
modparam("pike", "remove_latency", 130)
...
	    </programlisting>
	</example>
    </section>

</section>
