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

<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;

]>

<chapter id="pike.rpc" xmlns:xi="http://www.w3.org/2001/XInclude">

	<title>RPC calls</title>

	<section id="pike.top">
		<title>
			<function>pike.top</function>
		</title>
		<simpara>
			Pike.top behaves like a 'top' command and shows source IP addresses of incoming requestes to pike_check_req() function.
		</simpara>
		<simpara>
			The IP list is sorted by sum of leaf hits (prev and curr) descending and in second level by hits.
		</simpara>
		<simpara>
			Some IPs could be marked as HOT depending on theirs request rates.
		</simpara>
		<simpara>
			pike.top command can take one string parameter which specifies what kind of nodes you are interested in. Possible values
			are HOT or ALL. If no argument is given, it behaves as HOT was used.
		</simpara>
		<simpara>
			Marking nodes HOT is done on server side, client only presents given data and make some postprocessing like sorting.
		</simpara>
		<simpara>
			Output of this command is a simple dump of ip_tree nodes marked as ip-leafs.
		</simpara>
		<example>
		<title>Using <varname>pike.top</varname></title>
		<programlisting format="linespecific">
...
&kamcli; rpc pike.top ALL
...
</programlisting>
		</example>

	</section>
	<section id="pike.list">
		<title>
			<function>pike.list</function>
		</title>
		<para>
			Alias for "pike.top" command.
		</para>
	</section>

</chapter>
