Library Version 12.1.6.0

DbEnv::mutex_set_max()
Prev | Chapter 10. Mutex Methods | Next

## DbEnv::mutex_set_max()

    #include <db_cxx.h>

    int
    DbEnv::mutex_set_max(u_int32_t max);

Configure the total number of mutexes to allocate. This method is deprecated. The maximum size of the mutex region is now inferred by the sizes of the other memory structures, and so this method is no longer needed. For example, the cache requires one mutex per page in the cache. When you specify the cache size, DB assumes a page size of 4K and allocates mutexes accordingly. If your page size is different than 4K, you indicate this using DbEnv::set_mp_pagesize(). DB will then allocate the proper number of mutexes based on this new page size.

You can use this method to override DB's mutex calculation, but it is not recommended to do so.

Calling the `DbEnv::mutex_set_max()` method discards any value previously set using the DbEnv::mutex_set_increment() method.

The database environment's total number of mutexes may also be configured using the environment's DB_CONFIG file. The syntax of the entry in that file is a single line with the string "mutex_set_max", one or more whitespace characters, and the total number of mutexes. Because the DB_CONFIG file is read when the database environment is opened, it will silently overrule configuration done before that time.

The `DbEnv::mutex_set_max()` method configures a database environment, not only operations performed using the specified DbEnv handle.

The `DbEnv::mutex_set_max()` method may not be called after the DbEnv::open() method is called. If the database environment already exists when DbEnv::open() is called, the information specified to `DbEnv::mutex_set_max()` will be ignored.

The `DbEnv::mutex_set_max()` 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

#### max

The max parameter is the absolute number of mutexes to allocate.

### Errors

The `DbEnv::mutex_set_max()` 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:

#### EINVAL

An invalid flag value or parameter was specified.

### Class

DbEnv

### See Also

Mutex Methods

Prev | Up | Next
DbEnv::mutex_set_init() | Home | DbEnv::mutex_set_tas_spins()