Documentation Home
MySQL NDB Cluster API Developer Guide
Download this Manual ndb_logevent_get_next()

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


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


Prior to NDB 7.3.2, the log event's ndb_mgm_event_category was cast to an enum type. This behavior, although incorrect, interfered with existing applications and was reinstated in NDB 7.3.7; a new function exhibiting the corrected behavior ndb_logevent_get_next2() was added in these releases.

Parameters.  Three parameters are expected by this function:

  • 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.