MySQL :: MySQL Cluster API Developer Guide :: 3.2.1.5 ndb_logevent_get

MySQL Cluster API Developer Guide :: 3 The MGM API :: 3.2 MGM C API Function Listing :: 3.2.1 Log Event Functions :: 3.2.1.5 ndb_logevent_get_next()

« 3.2.1.4 ndb_logevent_get_fd()

3.2.1.6 ndb_logevent_get_latest_error() »

Section Navigation [Toggle]

3.2.1 Log Event Functions
3.2.1.1 ndb_mgm_listen_event()
3.2.1.2 ndb_mgm_create_logevent_handle()
3.2.1.3 ndb_mgm_destroy_logevent_handle()
3.2.1.4 ndb_logevent_get_fd()
3.2.1.5 ndb_logevent_get_next()
3.2.1.6 ndb_logevent_get_latest_error()
3.2.1.7 ndb_logevent_get_latest_error_msg()

3.2.1.5. `ndb_logevent_get_next()`

Description. This function is used to retrieve the next log event, using the event's data to fill in the supplied ndb_logevent structure.

Signature.

int ndb_logevent_get_next
    (
      const NdbLogEventHandle handle,
      struct ndb_logevent*    logevent,
      unsigned                timeout
    )

Parameters. Three parameters are expected by this functions:

An NdbLogEventHandle
A pointer to an ndb_logevent data structure
The number of milliseconds to wait for the event before timing out; passing 0 for this parameter causes the function to block until the next log event is received

Return value. The value returned by this function is interpreted as follows: If the return value is less than or equal to zero, then the logevent is not altered or affected in any way.

> 0: The event exists, and it data was retrieved into the logevent
0: A timeout occurred while waiting for the event (more than timeout milliseconds elapsed)
< 0: An error occurred.

Top / Previous / Next / Up / Table of Contents

3.2.1.5. ndb_logevent_get_next()

3.2.1.5. `ndb_logevent_get_next()`