DB->set_feedback

APIRef

#include <db.h>

int DB->set_feedback(DB *, void (*db_feedback_fcn)(DB *dbp, int opcode, int pct));

Description

Some operations performed by the Berkeley DB library can take non-trivial amounts of time. The DB->set_feedback method 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 database handle; 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_UPGRADE
The underlying database is being upgraded.

DB_VERIFY
The underlying database is being verified.

The DB->set_feedback interface may be called at any time during the life of the application.

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

Class

DB

See Also

Databases and Related Methods

APIRef

Copyright Sleepycat Software