# DbEnv::lock_detect

`

###

    #include <db_cxx.h>

    int
    DbEnv::lock_detect(u_int32_t flags, u_int32_t atype, int *aborted);

# Description

The DbEnv::lock_detect method runs one iteration of the deadlock detector. The deadlock detector traverses the lock table and marks one of the participating lock requesters for rejection in each deadlock it finds.

The flags parameter is currently unused, and must be set to 0.

The atype parameter specifies which lock request(s) to reject. It must be set to one following list:

DB_LOCK_DEFAULT
  Use whatever lock policy was specified when the database environment was created. If no lock policy has yet been specified, set the lock policy to DB_LOCK_RANDOM.
DB_LOCK_EXPIRE
  Reject lock requests which have timed out. No other deadlock detection is performed.
DB_LOCK_MAXLOCKS
  Reject the lock request for the locker ID with the greatest number of locks.
DB_LOCK_MINLOCKS
  Reject the lock request for the locker ID with the fewest number of locks.
DB_LOCK_MINWRITE
  Reject the lock request for the locker ID with the fewest number of write locks.
DB_LOCK_OLDEST
  Reject the lock request for the oldest locker ID.
DB_LOCK_RANDOM
  Reject the lock request for a random locker ID.
DB_LOCK_YOUNGEST
  Reject the lock request for the youngest locker ID.

If the aborted parameter is non-NULL, the memory location to which it refers will be set to the number of lock requests that were rejected.

The DbEnv::lock_detect 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::lock_detect 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::lock_detect 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

DbEnv, DbLock

# See Also

DbEnv::set_lk_conflicts, DbEnv::set_lk_detect, DbEnv::set_lk_max_lockers, DbEnv::set_lk_max_locks, DbEnv::set_lk_max_objects, DbEnv::lock_detect, DbEnv::lock_get, DbEnv::lock_id, DbEnv::lock_id_free, DbEnv::lock_put, DbEnv::lock_stat, and DbEnv::lock_vec.`

Copyright Sleepycat Software