diff options
Diffstat (limited to 'libmariadb/man/mariadb_rpl_fetch.3')
| -rw-r--r-- | libmariadb/man/mariadb_rpl_fetch.3 | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/libmariadb/man/mariadb_rpl_fetch.3 b/libmariadb/man/mariadb_rpl_fetch.3 new file mode 100644 index 00000000..38c77636 --- /dev/null +++ b/libmariadb/man/mariadb_rpl_fetch.3 @@ -0,0 +1,42 @@ +.\" Automatically generated by Pandoc 2.5 +.\" +.TH "mariadb_rpl_fetch" "3" "" "Version 3.3.1" "MariaDB Connector/C" +.hy +.SS Name +.PP +mariadb_rpl_fetch \- fetches next event from replication stream +.SS Synopsis +.IP +.nf +\f[C] +#include <mariadb_rpl.h> + +MARIADB_RPL_EVENT *mariadb_rpl_fetch(MARIADB_RPL *rpl, MARIADB_RPL_EVENT *event) +\f[R] +.fi +.SS Description +.PP +Fetches one event from the replication stream +.SS Parameter +.IP \[bu] 2 +\f[C]rpl\f[R] \- A replication handle which was initialized by +\f[B]mariadb_rpl_init(3)\f[R] and connected by +\f[B]mariadb_rpl_open(3)\f[R]. +.IP \[bu] 2 +\f[C]event\f[R] \- An event which was returned by a previous call to +\f[C]mariadb_rpl_fetch\f[R]. +If this value is \f[C]NULL\f[R] the function will allocate new memory +for the event, otherwise the passed event value will be overwritten. +.SS Return value +.PP +An event handle or NULL if EOF packet was received. +.SS Notes +.PP +Event memory needs to be freed by calling +\f[B]mariadb_rpl_free_event(3)\f[R]. +.SS See also +.IP \[bu] 2 +\f[B]mariadb_rpl_free_event(3)\f[R] +.SS History +.PP +\f[C]mariadb_rpl_fetch\f[R] was added in MariaDB Connector/C 3.1.0 |