mysql_ping — Pings a server connection

int mysql_ping(MYSQL * mysql);

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() or mysql_real_connect().

Return value

Zero on success, nonzero if an error occured.

[Note]

If a reconnect occured the thread_id will change. Also resources bundled to the connection (prepared statements, locks, temporary tables, ...) will be released.

See also

mysql_options(), mysql_kill()