FreeBSD Manual Pages
mysql_ping(3) MariaDB Connector/C mysql_ping(3)
Name
mysql_ping - checks if the connection between client and server is
working
Synopsis
#include <mysql.h>
int mysql_ping(MYSQL * mysql);
Description
Checks whether the connection to the server is working. If it has gone
down, and global option reconnect is enabled an automatic reconnection
is attempted.
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.
Parameters
• mysql - a mysql handle, which was previously allocated by
mysql_init(3) and connected by mysql_real_connect(3). ### Notes
• If a reconnect occurred the thread_id will change. Also resources
bundled to the connection (prepared statements, locks, temporary ta-
bles, ...) will be released.
Return value
Returns zero on success, nonzero if an error occurred.
See also
• mysql_optionsv(3)
• mysql_kill(3)
Version 3.4 mysql_ping(3)
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mysql_ping&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>