#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. The purpose of the lsn argument 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 immediately written back to disk (for example, pages that are currently in use by another thread of control) are waited for and written to disk as soon as it is possible to do so. If lsn is NULL, all modified pages in the pool are written to disk.

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, and returns 0 on success.

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 a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

See Also