# db_env_set_pageyield

`

###

    #include <db.h>

    int
    db_env_set_pageyield(int pageyield);

# Description

Yield the processor whenever requesting a page from the cache. Setting pageyield to a non-zero value causes Berkeley DB to yield the processor any time a thread requests a page from the cache. This functionality should never be used for any other purpose than stress testing.

The db_env_set_pageyield interface affects the entire application, not a single database or database environment.

The db_env_set_pageyield interface may be used to configure Berkeley DB at any time during the life of the application.

The db_env_set_pageyield function returns a non-zero error value on failure and 0 on success.

# Errors

The db_env_set_pageyield function may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

The db_env_set_pageyield function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the db_env_set_pageyield function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# See Also

db_env_create, DB_ENV->close, DB_ENV->err, DB_ENV->errx DB_ENV->open, DB_ENV->remove, DB_ENV->set_alloc, DB_ENV->set_cachesize, DB_ENV->set_data_dir, DB_ENV->set_errcall, DB_ENV->set_errfile, DB_ENV->set_errpfx, DB_ENV->set_feedback, DB_ENV->set_flags, DB_ENV->set_mutexlocks, db_env_set_pageyield, DB_ENV->set_paniccall, db_env_set_panicstate, DB_ENV->set_recovery_init, DB_ENV->set_rpc_server, db_env_set_region_init, DB_ENV->set_shm_key, db_env_set_tas_spins, DB_ENV->set_tmp_dir, DB_ENV->set_verbose, db_strerror and db_version.`

Copyright Sleepycat Software