DbEnv::lock_stat API Ref

#include <db_cxx.h>

int DbEnv::lock_stat(DB_LOCK_STAT **statp, u_int32_t flags);

int DbEnv::lock_stat_print(u_int32_t flags);


Description: DbEnv::lock_stat

The DbEnv::lock_stat method returns the locking subsystem statistics.

The DbEnv::lock_stat method creates a statistical structure of type DB_LOCK_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_LOCK_STAT fields will be filled in:


u_int32_t st_id; u_int32_t st_cur_maxid; u_int32_t st_nmodes; u_int32_t st_maxlocks; u_int32_t st_maxlockers; u_int32_t st_maxobjects; u_int32_t st_partitions; u_int32_t st_nlocks; u_int32_t st_maxnlocks; u_int32_t st_maxhlocks; u_int32_t st_locksteals; u_int32_t st_maxlsteals; u_int32_t st_nlockers; u_int32_t st_maxnlockers; u_int32_t st_nobjects; u_int32_t st_maxnobjects; u_int32_t st_maxhobjects; u_int32_t st_objectsteals; u_int32_t st_maxosteals; u_int32_t st_nrequests; u_int32_t st_nreleases; u_int32_t st_nupgrade; u_int32_t st_ndowngrade; u_int32_t st_lock_wait; u_int32_t st_lock_nowait; u_int32_t st_ndeadlocks; u_int32_t st_locktimeout; u_int32_t st_nlocktimeouts; u_int32_t st_txntimeout; u_int32_t st_ntxntimeouts; u_int32_t st_objs_wait; u_int32_t st_objs_nowait; u_int32_t st_lockers_wait; u_int32_t st_lockers_nowait; u_int32_t st_hash_len; roff_t st_regsize; u_int32_t st_part_wait; u_int32_t st_part_nowait; u_int32_t st_part_max_wait; u_int32_t st_part_max_nowait; u_int32_t st_region_wait; u_int32_t st_region_nowait;

The DbEnv::lock_stat method may not be called before the DbEnv::open method is called.

The DbEnv::lock_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.

Parameters
flags statp

Errors

The DbEnv::lock_stat method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:


EINVAL

Description: DbEnv::lock_stat_print

The DbEnv::lock_stat_print method displays the locking subsystem statistical information, as described for the DbEnv::lock_stat method. The information is printed to a specified output channel (see the DbEnv::set_msgfile method for more information), or passed to an application callback function (see the DbEnv::set_msgcall method for more information).

The DbEnv::lock_stat_print method may not be called before the DbEnv::open method is called.

The DbEnv::lock_stat_print 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.

Parameters
flags


Class DbEnv, DbLock
See Also Locking Subsystem and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.