summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_reconnect.3
blob: 3a89b545ae234a34d6c1f574c2222a3d76274394 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mariadb_reconnect" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mariadb_reconnect \- reconnects to a server
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

my_bool  mariadb_reconnect(MYSQL * mysql)
\f[R]
.fi
.SS Description
.PP
\f[C]mariadb_reconnect()\f[R] tries to reconnect to a server in case the
connection died due to timeout or other errors.
It uses the same credentials which were specified in
\f[B]mysql_real_connect(3)\f[R].
.SS Return value
.PP
The function will return 0 on sucess, a non zero value on error
.PP
\f[B]Note\f[R]: The function will return an error, if the option
\f[C]MYSQL_OPT_RECONNECT\f[R] wasn\[cq]t set before.
.SS History
.PP
\f[C]mariadb_reconnect()\f[R] was added in MariaDB Connector/C 3.0
.SS See also
.IP \[bu] 2
\f[B]mysql_real_connect(3)\f[R]
.IP \[bu] 2
\f[B]mysql_optionsv(3)\f[R]