#include <db_cxx.h>

DbEnv::mutex_stat(DB_MUTEX_STAT **statp, u_int32_t flags); 

The DbEnv::mutex_stat() method returns the mutex subsystem statistics.

The DbEnv::mutex_stat() method creates a statistical structure of type DB_MUTEX_STAT and copies a pointer to it into a user-specified memory location.

Statistical structures are stored in allocated memory. If application-specific allocation routines have been declared (see DbEnv::set_alloc() for more information), they are used to allocate the memory; otherwise, the standard C library malloc(3) is used. The caller is responsible for deallocating the memory. To deallocate the memory, free the memory reference; references inside the returned memory need not be individually freed.

The following DB_MUTEX_STAT fields will be filled in:

The DbEnv::mutex_stat() method may not be called before the DbEnv::open() method is called.

The DbEnv::mutex_stat() 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.



The statp parameter references memory into which a pointer to the allocated statistics structure is copied.


The flags parameter must be set to 0 or the following value:


    Reset statistics after returning their values.


The DbEnv::mutex_stat() method may fail and throw a DbException exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:


An invalid flag value or parameter was specified.



See Also

Mutex Methods