mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-04-18 21:24:07 +03:00
35 lines
1.1 KiB
Groff
35 lines
1.1 KiB
Groff
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mariadb_rpl_fetch" "3" "" "Version 3.3" "MariaDB Connector/C"
|
|
.SS Name
|
|
mariadb_rpl_fetch \- fetches next event from replication stream
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mariadb_rpl.h>\f[R]
|
|
|
|
MARIADB_RPL_EVENT *mariadb_rpl_fetch(MARIADB_RPL *rpl, MARIADB_RPL_EVENT *event)
|
|
.EE
|
|
.SS Description
|
|
Fetches one event from the replication stream
|
|
.SS Parameter
|
|
.IP \[bu] 2
|
|
\f[CR]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[CR]event\f[R] \- An event which was returned by a previous call to
|
|
\f[CR]mariadb_rpl_fetch\f[R].
|
|
If this value is \f[CR]NULL\f[R] the function will allocate new memory
|
|
for the event, otherwise the passed event value will be overwritten.
|
|
.SS Return value
|
|
An event handle or NULL if EOF packet was received.
|
|
.SS Notes
|
|
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
|
|
\f[CR]mariadb_rpl_fetch\f[R] was added in MariaDB Connector/C 3.1.0
|