cvs: phpdoc /en/functions ircg.xml

georg Mon Dec 31 09:51:54 2001 EDT Modified files: /phpdoc/en/functions ircg.xml Log: documentation for function ircg_set_on_die /en/functions/ircg.xml is complete now (until sascha has new ideas :-) Index: phpdoc/en/functions/ircg.xml diff -u phpdoc/en/functions/ircg.xml:1.19 phpdoc/en/functions/ircg.xml:1.20 --- phpdoc/en/functions/ircg.xml:1.19 Mon Dec 31 06:38:19 2001 +++ phpdoc/en/functions/ircg.xml Mon Dec 31 09:51:54 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.19 $ --> +<!-- $Revision: 1.20 $ --> <reference id="ref.ircg"> <title>IRC Gateway Functions</title> <titleabbrev>IRC Gateway</titleabbrev> @@ -639,7 +639,7 @@ <refnamediv> <refname>ircg_set_on_die</refname> <refpurpose> - Set hostaction to be execute when connection dies */ + Set hostaction to be execute when connection dies </refpurpose> </refnamediv> <refsect1> @@ -654,7 +654,13 @@ </funcprototype> </funcsynopsis> <para> - &warn.undocumented.func; + In case of the termination of connection <parameter>connection</parameter> + IRCG will connect to <parameter>host</parameter> at + <parameter>port</parameter> (Note: host must be an IPv4 address, + IRCG does not resolve host-names due to blocking issues), send + <parameter>data</parameter> to the new host connection and will + wait until the remote part closes connection. This can be used to + trigger a php script for example. </para> </refsect1> </refentry>