php-doc-en/reference/mysqli/functions/mysqli-ping.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
  <refentry id="function.mysqli-ping">
   <refnamediv>
    <refname>mysqli_ping</refname>
    <refname>mysqli->ping</refname>
    <refpurpose>
     Pings a server connection, or tries to reconnect if the connection has gone down.
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <para>Procedural style:</para>
    <methodsynopsis>
     <type>int</type><methodname>mysqli_ping</methodname>
     <methodparam><type>object</type><parameter>link</parameter></methodparam>
    </methodsynopsis>
    <para>Object oriented style (method):</para>
    <classsynopsis>
     <ooclass><classname>mysqli</classname></ooclass>
     <methodsynopsis>
      <type>int</type><methodname>ping</methodname>
      <methodparam><type>void</type><parameter></parameter></methodparam>
     </methodsynopsis>
    </classsynopsis>
    <para>
     Checks whether the connection to the server is working. If it has gone
     down, an automatic reconnection is attempted.
    </para>
    <para>
     This function can be used by clients that remain idle for a long while,
     to check whether the server has closed the connection and reconnect if
     necessary.
    </para>
    <para>
     <function>mysqli_ping</function> returns 0 if the connection is alive
     and non-zero value if an error has occured.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->