summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_reconnect.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mariadb_reconnect.3')
-rw-r--r--libmariadb/man/mariadb_reconnect.336
1 files changed, 36 insertions, 0 deletions
diff --git a/libmariadb/man/mariadb_reconnect.3 b/libmariadb/man/mariadb_reconnect.3
new file mode 100644
index 00000000..3a89b545
--- /dev/null
+++ b/libmariadb/man/mariadb_reconnect.3
@@ -0,0 +1,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]