cvs: peardoc /en/packages networking.xml

mj Mon Dec 17 13:50:28 2001 EDT Modified files: /peardoc/en/packages networking.xml Log: * Add documentation for Net_Ping. Index: peardoc/en/packages/networking.xml diff -u peardoc/en/packages/networking.xml:1.1 peardoc/en/packages/networking.xml:1.2 --- peardoc/en/packages/networking.xml:1.1 Fri Dec 14 12:10:58 2001 +++ peardoc/en/packages/networking.xml Mon Dec 17 13:50:28 2001 @@ -140,4 +140,47 @@ </refsect1> </refentry> + <refentry id="packages.Networking.Net_Ping"> + <refnamediv> + <refname><classname>Net_Ping</classname></refname> + <refpurpose> + Wrapper class for ping calls + </refpurpose> + </refnamediv> + + <refsect1 id="packages.Networking.Net_Ping.ping"> + <title>Net_Ping::ping</title> + + <funcsynopsis> + <funcprototype> + <funcdef>array <function>Net_Ping::ping</function></funcdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>integer <parameter>counts</parameter></paramdef> + <paramdef>integer <parameter>packet_size</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + Execute ping and return result. + </para> + <example> + <title>Using ping</title> + <programlisting role="php"> +require_once "Net_Ping/Ping.php"; + +$ping = new Net_Ping; + +print_r($ping->ping("127.0.0.1"); + </programlisting> + </example> + + <para> + By passing a value for the second parameter <parameter>counts + </parameter> you can specify the number of signals that are sent + to <parameter>host</parameter> (default is 5). The third + parameter <parameter> packet_size</parameter> can be used to + change the size of the packets that are sent. + </para> + </refsect1> + </refentry> + </reference>