mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 00:37:15 +01:00
43 lines
1.1 KiB
Groff
43 lines
1.1 KiB
Groff
.\" Automatically generated by Pandoc 2.5
|
|
.\"
|
|
.TH "mariadb_rpl_fetch" "3" "" "Version 3.2.2" "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
|