Whole document tree
    

Whole document tree

Berkeley DB: DBENV->set_feedback

DBENV->set_feedback

APIRef

#include <db.h>

int DBENV->set_feedback(DB_ENV *, void (*db_feedback_fcn)(DB_ENV *, int opcode, int pct));

Description

Some operations performed by the Berkeley DB library can take non-trivial amounts of time. The DBENV->set_feedback function can be used by applications to monitor progress within these operations.

When an operation is likely to take a long time, Berkeley DB will call the specified callback function. This function must be declared with three arguments: the first will be a reference to the enclosing environment, the second a flag value, and the third the percent of the operation that has been completed, specified as an integer value between 0 and 100. It is up to the callback function to display this information in an appropriate manner.

The opcode argument may take on any of the following values:

DB_RECOVER
The environment is being recovered.

The DBENV->set_feedback interface may be used to configure Berkeley DB at any time during the life of the application.

The DBENV->set_feedback function returns a non-zero error value on failure and 0 on success.

See Also

DBENV->close, db_env_create, DBENV->open, DBENV->remove, DBENV->err, db_strerror, db_version, DBENV->set_cachesize, DBENV->set_errcall, DBENV->set_errfile, DBENV->set_errpfx, DBENV->set_flags, DBENV->set_mutexlocks, DBENV->set_paniccall, and DBENV->set_verbose.

APIRef

Copyright Sleepycat Software