Adding upstream version 1:10.11.6.upstream/1%10.11.6upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 36 insertions, 0 deletions

diff --git a/libmariadb/man/mariadb_cancel.3 b/libmariadb/man/mariadb_cancel.3
new file mode 100644
index 00000000..38729c2d
--- /dev/null
+++ b/libmariadb/man/mariadb_cancel.3
@@ -0,0 +1,36 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mariadb_cancel" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mariadb_cancel \- Immediately aborts a connection
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+int mariadb_cancel(MYSQL * mysql);
+\f[R]
+.fi
+.SS Description
+.PP
+Immediately aborts a connection by making all subsequent read/write
+operations fail.
+\f[C]mariadb_cancel()\f[R] does not invalidate memory used for
+\f[C]mysql\f[R] structure, nor close any communication channels.
+To free the memory, \f[B]mysql_close(3)\f[R] must be called.
+\f[C]mariadb_cancel()\f[R] is useful to break long queries in situations
+where sending KILL is not possible.
+.SS Parameter
+.PP
+\f[C]mysql\f[R] \- 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].
+.SS Return value
+.PP
+Returns zero on success or a non\-zero value on error.
+.SS History
+.PP
+\f[C]mariadb_cancel()\f[R] was added in Connector/C 3.0