summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_rpl_fetch.3
blob: 38c77636777fcbb08a2a3fc674e97cb6c3fd2a9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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