mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
5a9a466dfd
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@157179 c90b9560-bf6c-de11-be94-00142212c4b1
125 lines
3.1 KiB
XML
125 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<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>bool</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>bool</type><methodname>ping</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
Checks whether the connection to the server is working. If it has gone
|
|
down, and global option <literal>mysqli.reconnect</literal> is enabled
|
|
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>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Return values</title>
|
|
<para>&return.success;</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<example>
|
|
<title>Object oriented style</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
|
|
|
|
/* check connection */
|
|
if (mysqli_connect_errno()) {
|
|
printf("Connect failed: %s\n", mysqli_connect_error());
|
|
exit();
|
|
}
|
|
|
|
/* check if server is alive */
|
|
if ($mysqli->ping()) {
|
|
printf ("Our connection is ok!\n");
|
|
} else {
|
|
printf ("Error: %s\n", $mysqli->error);
|
|
}
|
|
|
|
/* close connection */
|
|
$mysqli->close();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>Procedural style</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
|
|
|
|
/* check connection */
|
|
if (mysqli_connect_errno()) {
|
|
printf("Connect failed: %s\n", mysqli_connect_error());
|
|
exit();
|
|
}
|
|
|
|
/* check if server is alive */
|
|
if (mysqli_ping($link)) {
|
|
printf ("Our connection is ok!\n");
|
|
} else {
|
|
printf ("Error: %s\n", mysqli_error($link));
|
|
}
|
|
|
|
/* close connection */
|
|
mysqli_close($link);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<para>
|
|
The above examples would produce the following output:
|
|
</para>
|
|
<screen>
|
|
<![CDATA[
|
|
Our connection is ok!
|
|
]]>
|
|
</screen>
|
|
</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
|
|
-->
|