#include <db_cxx.h>

int
DbEnv::memp_sync(DbLsn *lsn);

Description

The DbEnv::memp_sync method ensures that any modified pages in the pool with a log sequence number (DbLsn) less than the lsn argument are written to disk. If lsn is NULL, all modified pages in the pool are flushed.

The primary purpose of the DbEnv::memp_sync function is to enable a transaction manager to ensure, as part of a checkpoint, that all pages modified by a certain time have been written to disk. Pages in the pool that cannot be written back to disk immediately (for example, pages that are currently pinned) are written to disk as soon as it is possible to do so. The expected behavior of the Berkeley DB or other Transaction subsystem is to call the DbEnv::memp_sync function and then, if the return indicates that some pages could not be written immediately, to wait briefly and retry again with the same log sequence number until the DbEnv::memp_sync function returns that all pages have been written.

To support the DbEnv::memp_sync functionality, it is necessary that the pool functions know the location of the log sequence number on the page for each file type. This location should be specified when the file is opened using the DbMpoolFile::set_lsn_offset method. It is not required that the log sequence number be aligned on the page in any way.

The DbEnv::memp_sync method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, 0 on success, and returns DB_INCOMPLETE if there were pages which need to be written but that DbEnv::memp_sync was unable to write immediately. In addition, if DbEnv::memp_sync returns success, the value of lsn will be overwritten with the largest log sequence number from any page that was written by DbEnv::memp_sync to satisfy this request.

Errors

The DbEnv::memp_sync method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL

An invalid flag value or parameter was specified.

The DbEnv::memp_sync function was called without logging having been initialized in the environment.

The DbEnv::memp_sync method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::memp_sync method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

See Also