7.4.7 mysql_reset_connection_nonblocking()

enum net_async_status
mysql_reset_connection_nonblocking(MYSQL *mysql)

Description

Note

mysql_reset_connection_nonblocking() is an asynchronous function. It is the counterpart of the mysql_reset_connection() synchronous function, for use by applications that require asynchronous communication with the server. For general information about writing asynchronous C API applications, see Chapter 7, C API Asynchronous Interface.

mysql_reset_connection_nonblocking() is used similarly to mysql_reset_connection(). For details about the latter, see Section 5.4.65, “mysql_reset_connection()”. The two functions differ as follows:

• mysql_reset_connection() returns a zero for success or a nonzero if an error occurred.

• mysql_reset_connection_nonblocking() returns an enum net_async_status status indicator.

  If mysql_reset_connection_nonblocking() returns NET_ASYNC_COMPLETE, then connection state has cleared successfully. Otherwise, continue to call mysql_reset_connection_nonblocking() from the client application until the function returns status NET_ASYNC_COMPLETE. A NET_ASYNC_ERROR return status indicates an error.

mysql_reset_connection_nonblocking() was added in MySQL 8.1.0.

Return Values

Returns an enum net_async_status value. See the description in Section 7.2, “C API Asynchronous Interface Data Structures”.

Example

See Chapter 7, C API Asynchronous Interface.