Version 1.3.0
WT_EVENT_HANDLER Struct Reference

The interface implemented by applications to handle error, informational and progress messages. More...

Public Attributes

int(* handle_error )(WT_EVENT_HANDLER *handler, int error, const char *message)
 Callback to handle error messages; by default, error messages are written to the stderr stream.
 
int(* handle_message )(WT_EVENT_HANDLER *handler, const char *message)
 Callback to handle informational messages; by default, informational messages are written to the stdout stream.
 
int(* handle_progress )(WT_EVENT_HANDLER *handler, const char *operation, uint64_t progress)
 Callback to handle progress messages; by default, no progress messages are written.
 

Detailed Description

The interface implemented by applications to handle error, informational and progress messages.

Entries set to NULL are ignored and the default handlers will continue to be used.

Member Data Documentation

int(* WT_EVENT_HANDLER::handle_error)(WT_EVENT_HANDLER *handler, int error, const char *message)

Callback to handle error messages; by default, error messages are written to the stderr stream.

If the handler returns non-zero, the application's current operation will return an error.

Parameters
errora WiredTiger, C99 or POSIX error code, which can be converted to a string using wiredtiger_strerror
messagean error string
int(* WT_EVENT_HANDLER::handle_message)(WT_EVENT_HANDLER *handler, const char *message)

Callback to handle informational messages; by default, informational messages are written to the stdout stream.

If the handler returns non-zero, the application's current operation will return an error.

Parameters
messagean informational string
int(* WT_EVENT_HANDLER::handle_progress)(WT_EVENT_HANDLER *handler, const char *operation, uint64_t progress)

Callback to handle progress messages; by default, no progress messages are written.

If the handler returns non-zero, the application's current operation will return an error.

Parameters
operationa string representation of the operation
progressa counter