mysql_ping.3

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_ping" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mysql_ping \- checks if the connection between client and server is
working
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]

int mysql_ping(MYSQL * mysql);
.EE
.SS 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.
.PP
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.
.SS Parameters
.IP \[bu] 2
\f[CR]mysql\f[R] \- a mysql handle, which was previously allocated by
\f[B]mysql_init(3)\f[R] and connected by
\f[B]mysql_real_connect(3)\f[R].
### Notes
.IP \[bu] 2
If a reconnect occurred the thread_id will change.
Also resources bundled to the connection (prepared statements, locks,
temporary tables, \&...)
will be released.
.SS Return value
Returns zero on success, nonzero if an error occurred.
.SS See also
.IP \[bu] 2
\f[B]mysql_optionsv(3)\f[R]
.IP \[bu] 2
\f[B]mysql_kill(3)\f[R]