Berkeley DB: DbMpool::close
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btr ee,hash,hashing,transaction,transactions,locking,logging,access method,access me thods,java,C,C++

# DbMpool::close

`

###

    #include <db_cxx.h>

    int
    DbMpool::close();

# Description

The DbMpool::close method closes the memory pool.

Calling DbMpool::close does not imply a call to DbMpoolFile::sync, but does imply a call to DbMpoolFile::close for any remaining open files in the pool returned to this process by calls to DbMpoolFile::open.

In addition, if the dir argument to DbMpool::open was NULL and dbenv was not initialized using DbEnv::appinit, or the DB_MPOOL_PRIVATE flag was set, all files created for this shared region will be removed, as if the DbMpool::unlink method were called.

In multi-threaded applications, only a single thread may call the DbMpool::close method.

The DbMpool::close method either returns errno or throws an exception that encapsulates an errno on failure, and 0 on success.

# Errors

If a fatal error occurs in Berkeley DB, the DbMpool::close method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, at which point all subsequent database calls will also fail in the same way. Methods marked as returning errno will, by default, throw an exception that encapsulates the error information. The default error behavior can be changed, see DbException.

The DbMpool::close method may fail and throw an exception for any of the errors specified for the following Berkeley DB and C library functions: abort(3), close(3), fcntl(3), fflush(3), fprintf(3), free(3), getpid(3), DbMpoolFile::close, memset(3), munmap(3), shmctl(3), shmdt(3), strlen(3), unlink(3), vfprintf(3), and vsnprintf(3).

# Class

DbMpool

# See Also

DbMpool::close, DbMpool::open, DbMpool::db_register, DbMpool::stat, DbMpool::sync, DbMpool::trickle and DbMpool::unlink.`