mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 16:57:16 +01:00
45 lines
1.1 KiB
Groff
45 lines
1.1 KiB
Groff
|
.\" Automatically generated by Pandoc 2.5
|
||
|
|
.\"
|
||
|
|
.TH "mysql_ping" "3" "" "Version 3.2.2" "MariaDB Connector/C"
|
||
|
|
.hy
|
||
|
|
.SS Name
|
||
|
|
.PP
|
||
|
|
mysql_ping \- checks if the connection between client and server is
|
||
|
|
working
|
||
|
|
.SS Synopsis
|
||
|
|
.IP
|
||
|
|
.nf
|
||
|
|
\f[C]
|
||
|
|
#include <mysql.h>
|
||
|
|
|
||
|
|
int mysql_ping(MYSQL * mysql);
|
||
|
|
\f[R]
|
||
|
|
.fi
|
||
|
|
.SS Description
|
||
|
|
.PP
|
||
|
|
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[C]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
|
||
|
|
.PP
|
||
|
|
Returns zero on success, nonzero if an error occured.
|
||
|
|
.SS See also
|
||
|
|
.IP \[bu] 2
|
||
|
|
\f[B]mysql_optionsv(3)\f[R]
|
||
|
|
.IP \[bu] 2
|
||
|
|
\f[B]mysql_kill(3)\f[R]
|