diff options
| author | jbj <devnull@localhost> | 2002-08-14 17:31:52 +0000 |
|---|---|---|
| committer | jbj <devnull@localhost> | 2002-08-14 17:31:52 +0000 |
| commit | 8faf9d1ea6d5743be84b20e509d52bab283ece71 (patch) | |
| tree | c5a2fc227a050adedb6329d61b0fa785387092d2 /db/docs/api_c | |
| parent | 4aac97a69fb764add274089dbc7a1c5bd02c59c8 (diff) | |
| download | rpm-8faf9d1ea6d5743be84b20e509d52bab283ece71.tar.gz rpm-8faf9d1ea6d5743be84b20e509d52bab283ece71.tar.bz2 rpm-8faf9d1ea6d5743be84b20e509d52bab283ece71.zip | |
db-4.1.17 orphans.
CVS patchset: 5632
CVS date: 2002/08/14 17:31:52
Diffstat (limited to 'db/docs/api_c')
| -rw-r--r-- | db/docs/api_c/env_set_timeout.html | 40 | ||||
| -rw-r--r-- | db/docs/api_c/lock_id_free.html | 13 | ||||
| -rw-r--r-- | db/docs/api_c/log_cursor.html | 22 | ||||
| -rw-r--r-- | db/docs/api_c/logc_close.html | 27 | ||||
| -rw-r--r-- | db/docs/api_c/logc_get.html | 64 | ||||
| -rw-r--r-- | db/docs/api_c/memp_fcreate.html | 26 | ||||
| -rw-r--r-- | db/docs/api_c/memp_set_clear_len.html | 34 | ||||
| -rw-r--r-- | db/docs/api_c/memp_set_fileid.html | 30 | ||||
| -rw-r--r-- | db/docs/api_c/memp_set_ftype.html | 33 | ||||
| -rw-r--r-- | db/docs/api_c/memp_set_lsn_offset.html | 34 | ||||
| -rw-r--r-- | db/docs/api_c/memp_set_pgcookie.html | 33 | ||||
| -rw-r--r-- | db/docs/api_c/rep_elect.html | 13 | ||||
| -rw-r--r-- | db/docs/api_c/rep_message.html | 57 | ||||
| -rw-r--r-- | db/docs/api_c/rep_start.html | 13 | ||||
| -rw-r--r-- | db/docs/api_c/rep_transport.html | 21 | ||||
| -rw-r--r-- | db/docs/api_c/txn_set_timeout.html | 29 |
16 files changed, 289 insertions, 200 deletions
diff --git a/db/docs/api_c/env_set_timeout.html b/db/docs/api_c/env_set_timeout.html index e55e1450f..dfe94bda6 100644 --- a/db/docs/api_c/env_set_timeout.html +++ b/db/docs/api_c/env_set_timeout.html @@ -1,6 +1,7 @@ -<!--Id: env_set_timeout.so,v 10.3 2001/10/22 15:24:31 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: env_set_timeout.so,v 10.6 2002/06/24 14:49:21 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->set_timeout</title> @@ -59,40 +60,57 @@ detection is performed. <p>Timeout values specified for the database environment may be overridden on a per-lock or per-transaction basis. See <a href="../api_c/lock_vec.html">DB_ENV->lock_vec</a> and <a href="../api_c/txn_set_timeout.html">DB_TXN->set_timeout</a> for more information. -<p>The DB_ENV->set_timeout interface may be used only to configure Berkeley DB before -the <a href="../api_c/env_open.html">DB_ENV->open</a> interface is called. +<p>The DB_ENV->set_timeout function configures a database environment, not only operations +performed using the specified <a href="../api_c/env_create.html">DB_ENV</a> handle. +<p>The DB_ENV->set_timeout interface may be called at any time during the life of +the application. <p>The DB_ENV->set_timeout function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_ENV->set_timeout function may fail and return a non-zero error for the following conditions: <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -<p>Called after <a href="../api_c/env_open.html">DB_ENV->open</a> was called. </dl> <p>The DB_ENV->set_timeout 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_timeout function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->set_timeout function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_create.html">db_env_create</a>, <a href="../api_c/env_close.html">DB_ENV->close</a>, -<a href="../api_c/env_err.html">DB_ENV->err</a>, <a href="../api_c/env_err.html">DB_ENV->errx</a> +<a href="../api_c/env_dbremove.html">DB_ENV->dbremove</a>, +<a href="../api_c/env_dbrename.html">DB_ENV->dbrename</a>, +<a href="../api_c/env_err.html">DB_ENV->err</a>, +<a href="../api_c/env_err.html">DB_ENV->errx</a>, <a href="../api_c/env_open.html">DB_ENV->open</a>, <a href="../api_c/env_remove.html">DB_ENV->remove</a>, <a href="../api_c/env_set_alloc.html">DB_ENV->set_alloc</a>, +<a href="../api_c/env_set_app_dispatch.html">DB_ENV->set_app_dispatch</a>, <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_data_dir.html">DB_ENV->set_data_dir</a>, +<a href="../api_c/env_set_encrypt.html">DB_ENV->set_encrypt</a>, <a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a>, <a href="../api_c/env_set_errfile.html">DB_ENV->set_errfile</a>, <a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a>, <a href="../api_c/env_set_feedback.html">DB_ENV->set_feedback</a>, <a href="../api_c/env_set_flags.html">DB_ENV->set_flags</a>, +<a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a>, +<a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a>, +<a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a>, +<a href="../api_c/env_set_lk_conflicts.html">DB_ENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DB_ENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DB_ENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_locks.html">DB_ENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_objects.html">DB_ENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, <a href="../api_c/env_set_paniccall.html">DB_ENV->set_paniccall</a>, -<a href="../api_c/env_set_rec_init.html">DB_ENV->set_recovery_init</a>, <a href="../api_c/env_set_rpc_server.html">DB_ENV->set_rpc_server</a>, <a href="../api_c/env_set_shm_key.html">DB_ENV->set_shm_key</a>, <a href="../api_c/env_set_tas_spins.html">DB_ENV->set_tas_spins</a>, -<a href="../api_c/env_set_tmp_dir.html">DB_ENV->set_tmp_dir</a>, <a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a>, +<a href="../api_c/env_set_tmp_dir.html">DB_ENV->set_tmp_dir</a>, +<a href="../api_c/env_set_tx_max.html">DB_ENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_timestamp.html">DB_ENV->set_tx_timestamp</a>, <a href="../api_c/env_set_verbose.html">DB_ENV->set_verbose</a>, <a href="../api_c/env_strerror.html">db_strerror</a> and diff --git a/db/docs/api_c/lock_id_free.html b/db/docs/api_c/lock_id_free.html index 0f32651a5..73e8a31d2 100644 --- a/db/docs/api_c/lock_id_free.html +++ b/db/docs/api_c/lock_id_free.html @@ -1,6 +1,7 @@ -<!--Id: lock_id_free.so,v 10.2 2001/10/22 15:24:32 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: lock_id_free.so,v 10.4 2002/06/24 14:49:23 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->lock_id_free</title> @@ -34,9 +35,9 @@ DB_ENV->lock_id function. <p>The locker ID is invalid or locks are still held by this locker ID. </dl> <p>The DB_ENV->lock_id_free 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->lock_id_free function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->lock_id_free function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_lk_conflicts.html">DB_ENV->set_lk_conflicts</a>, <a href="../api_c/env_set_lk_detect.html">DB_ENV->set_lk_detect</a>, @@ -48,7 +49,7 @@ in the same way. <a href="../api_c/lock_id.html">DB_ENV->lock_id</a>, <a href="../api_c/lock_id_free.html">DB_ENV->lock_id_free</a>, <a href="../api_c/lock_put.html">DB_ENV->lock_put</a>, -<a href="../api_c/lock_stat.html">DB_ENV->lock_stat</a>, +<a href="../api_c/lock_stat.html">DB_ENV->lock_stat</a> and <a href="../api_c/lock_vec.html">DB_ENV->lock_vec</a>. </tt> diff --git a/db/docs/api_c/log_cursor.html b/db/docs/api_c/log_cursor.html index 0bf50ab34..33e0f5173 100644 --- a/db/docs/api_c/log_cursor.html +++ b/db/docs/api_c/log_cursor.html @@ -1,6 +1,7 @@ -<!--Id: log_cursor.so,v 10.2 2001/10/22 15:24:33 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: log_cursor.so,v 10.3 2002/06/24 14:49:24 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->log_cursor</title> @@ -36,34 +37,37 @@ creates a log cursor and copies a pointer to it into the memory to which <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p>The DB_ENV->log_cursor 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->log_cursor function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->log_cursor function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_set_alloc.html">DB->set_alloc</a>, <a href="../api_c/db_associate.html">DB->associate</a>, <a href="../api_c/db_close.html">DB->close</a>, <a href="../api_c/db_cursor.html">DB->cursor</a>, <a href="../api_c/db_del.html">DB->del</a>, -<a href="../api_c/db_err.html">DB->err</a>, <a href="../api_c/db_err.html">DB->errx</a> +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_err.html">DB->errx</a>, <a href="../api_c/db_fd.html">DB->fd</a>, <a href="../api_c/db_get.html">DB->get</a>, -<a href="../api_c/db_get.html">DB->pget</a>, <a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, <a href="../api_c/db_get_type.html">DB->get_type</a>, <a href="../api_c/db_join.html">DB->join</a>, <a href="../api_c/db_key_range.html">DB->key_range</a>, <a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_get.html">DB->pget</a>, <a href="../api_c/db_put.html">DB->put</a>, <a href="../api_c/db_remove.html">DB->remove</a>, <a href="../api_c/db_rename.html">DB->rename</a>, -<a href="../api_c/db_set_alloc.html">DB->set_alloc</a>, <a href="../api_c/db_set_append_recno.html">DB->set_append_recno</a>, <a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, <a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, <a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cache_priority.html">DB->set_cache_priority</a>, <a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, <a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_encrypt.html">DB->set_encrypt</a>, <a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, <a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, <a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, @@ -83,7 +87,7 @@ in the same way. <a href="../api_c/db_stat.html">DB->stat</a>, <a href="../api_c/db_sync.html">DB->sync</a>, <a href="../api_c/db_truncate.html">DB->truncate</a>, -<a href="../api_c/db_upgrade.html">DB->upgrade</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> and <a href="../api_c/db_verify.html">DB->verify</a>. </tt> diff --git a/db/docs/api_c/logc_close.html b/db/docs/api_c/logc_close.html index 6747f34ef..59cf31bd5 100644 --- a/db/docs/api_c/logc_close.html +++ b/db/docs/api_c/logc_close.html @@ -1,6 +1,7 @@ -<!--Id: logc_close.so,v 10.4 2001/10/22 15:24:35 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: logc_close.so,v 10.5 2002/06/24 14:49:25 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_LOGC->close</title> @@ -37,23 +38,23 @@ used again. <p>The cursor was previously closed. </dl> <p>The DB_LOGC->close 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_LOGC->close function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_LOGC->close function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> -<a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a>, -<a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a>, -<a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a>, -<a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a>, <a href="../api_c/log_archive.html">DB_ENV->log_archive</a>, -<a href="../api_c/log_compare.html">log_compare</a>, -<a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a>, <a href="../api_c/log_file.html">DB_ENV->log_file</a>, <a href="../api_c/log_flush.html">DB_ENV->log_flush</a>, <a href="../api_c/log_put.html">DB_ENV->log_put</a>, -<a href="../api_c/log_register.html">DB_ENV->log_register</a>, <a href="../api_c/log_stat.html">DB_ENV->log_stat</a>, -<a href="../api_c/log_unregister.html">DB_ENV->log_unregister</a>, +<a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a>, +<a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a>, +<a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a>, +and +<a href="../api_c/log_compare.html">log_compare</a>. +<p> +<a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a>, <a href="../api_c/logc_close.html">DB_LOGC->close</a> and <a href="../api_c/logc_get.html">DB_LOGC->get</a>. diff --git a/db/docs/api_c/logc_get.html b/db/docs/api_c/logc_get.html index 4284db1b6..074763029 100644 --- a/db/docs/api_c/logc_get.html +++ b/db/docs/api_c/logc_get.html @@ -1,6 +1,7 @@ -<!--Id: logc_get.so,v 10.31 2001/10/22 15:24:35 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: logc_get.so,v 10.36 2002/07/01 16:52:26 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_LOGC->get</title> @@ -35,41 +36,38 @@ record. See <a href="../api_c/dbt.html">DBT</a> for a description of other fiel for any <a href="../api_c/dbt.html">DBT</a> used for data retrieval. <p>The <b>flags</b> value must be set to one of the following values: <p><dl compact> -<p><dt><a name="DB_CHECKPOINT">DB_CHECKPOINT</a><dd>The last record written with the DB_CHECKPOINT flag specified to the -<a href="../api_c/log_put.html">DB_ENV->log_put</a> function is returned in the <b>data</b> argument. The -<b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the record -returned. If no record has been previously written with the DB_CHECKPOINT -flag specified, the first record in the log is returned. -<p>If the log is empty, the DB_LOGC->get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. <p><dt><a name="DB_FIRST">DB_FIRST</a><dd>The first record from any of the log files found in the log directory is returned in the <b>data</b> argument. The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the record returned. -<p>If the log is empty, the DB_LOGC->get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p> +If the log is empty, the DB_LOGC->get function will return DB_NOTFOUND. <p><dt><a name="DB_LAST">DB_LAST</a><dd>The last record in the log is returned in the <b>data</b> argument. The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the record returned. -<p>If the log is empty, the DB_LOGC->get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p> +If the log is empty, the DB_LOGC->get function will return DB_NOTFOUND. <p><dt><a name="DB_NEXT">DB_NEXT</a>, <a name="DB_PREV">DB_PREV</a><dd>The current log position is advanced to the next (previous) record in the log, and that record is returned in the <b>data</b> argument. The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the record returned. -<p>If the pointer has not been initialized via DB_FIRST, DB_LAST, DB_SET, +<p>If the cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET, DB_NEXT, or DB_PREV, DB_LOGC->get will return the first (last) record -in the log. If the last (first) log record has already been returned -or the log is empty, the DB_LOGC->get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. -<p>If the log was opened with the DB_THREAD flag set, calls to -DB_LOGC->get with the DB_NEXT (DB_PREV) flag set will return -EINVAL. +in the log. +If the last (first) log record has already been returned or the log is +empty, the DB_LOGC->get function will return DB_NOTFOUND. +If the log was opened with the DB_THREAD flag set, calls to +DB_LOGC->get with the DB_NEXT (DB_PREV) flag set, the DB_LOGC->get function will return EINVAL. <p><dt><a name="DB_CURRENT">DB_CURRENT</a><dd>Return the log record to which the log currently refers. -<p>If the log pointer has not been initialized via DB_FIRST, DB_LAST, +If the log cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET, DB_NEXT, or DB_PREV, or if the log was opened with the DB_THREAD -flag set, DB_LOGC->get will return EINVAL. -<p><dt><a name="DB_SET">DB_SET</a><dd>Retrieve the record specified by the <b>lsn</b> argument. If the -specified <a href="../api_c/db_lsn.html">DB_LSN</a> is invalid (for example, it does not appear in -the log) DB_LOGC->get will return EINVAL. +flag set, the DB_LOGC->get function will return EINVAL. +<p><dt><a name="DB_SET">DB_SET</a><dd>Retrieve the record specified by the <b>lsn</b> argument. +If the specified <a href="../api_c/db_lsn.html">DB_LSN</a> is invalid (for example, it does not +appear in the log), the DB_LOGC->get function will return EINVAL. </dl> -<p>Otherwise, the DB_LOGC->get function returns a non-zero error value on failure and 0 on success. +<p> +Otherwise, the DB_LOGC->get function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_LOGC->get function may fail and return a non-zero error for the following conditions: <p><dl compact> @@ -80,23 +78,23 @@ initialized. exist. </dl> <p>The DB_LOGC->get 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_LOGC->get function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_LOGC->get function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> -<a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a>, -<a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a>, -<a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a>, -<a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a>, <a href="../api_c/log_archive.html">DB_ENV->log_archive</a>, -<a href="../api_c/log_compare.html">log_compare</a>, -<a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a>, <a href="../api_c/log_file.html">DB_ENV->log_file</a>, <a href="../api_c/log_flush.html">DB_ENV->log_flush</a>, <a href="../api_c/log_put.html">DB_ENV->log_put</a>, -<a href="../api_c/log_register.html">DB_ENV->log_register</a>, <a href="../api_c/log_stat.html">DB_ENV->log_stat</a>, -<a href="../api_c/log_unregister.html">DB_ENV->log_unregister</a>, +<a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a>, +<a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a>, +<a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a>, +and +<a href="../api_c/log_compare.html">log_compare</a>. +<p> +<a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a>, <a href="../api_c/logc_close.html">DB_LOGC->close</a> and <a href="../api_c/logc_get.html">DB_LOGC->get</a>. diff --git a/db/docs/api_c/memp_fcreate.html b/db/docs/api_c/memp_fcreate.html index 169c64051..34ab2e92b 100644 --- a/db/docs/api_c/memp_fcreate.html +++ b/db/docs/api_c/memp_fcreate.html @@ -1,6 +1,7 @@ -<!--Id: memp_fcreate.so,v 10.4 2001/10/22 15:24:35 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_fcreate.so,v 10.5 2002/06/24 14:49:26 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->memp_fcreate</title> @@ -33,29 +34,30 @@ Calling the <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a> funct <p>The DB_ENV->memp_fcreate function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_ENV->memp_fcreate 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->memp_fcreate function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->memp_fcreate function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/memp_set_clear_len.html b/db/docs/api_c/memp_set_clear_len.html index 02a90a849..e5de7ab2d 100644 --- a/db/docs/api_c/memp_set_clear_len.html +++ b/db/docs/api_c/memp_set_clear_len.html @@ -1,6 +1,7 @@ -<!--Id: memp_set_clear_len.so,v 10.2 2001/10/22 15:24:36 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_set_clear_len.so,v 10.4 2002/06/24 14:49:27 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_MPOOLFILE->set_clear_len</title> @@ -30,32 +31,41 @@ page that should be set to nul when the page is created as a result of the <a href="../api_c/memp_fget.html#DB_MPOOL_CREATE">DB_MPOOL_CREATE</a> or <a href="../api_c/memp_fget.html#DB_MPOOL_NEW">DB_MPOOL_NEW</a> flags being specified to <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>. If no value is specified, or <b>len</b> is 0, the entire page is cleared. +<p>The DB_MPOOLFILE->set_clear_len function configures a file in the memory pool, not only +operations performed using the specified <a href="../api_c/memp_fcreate.html">DB_MPOOLFILE</a> handle. +<p>The DB_MPOOLFILE->set_clear_len interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_clear_len +must be consistent with the existing file or an error will be +returned. <p>The DB_MPOOLFILE->set_clear_len function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_MPOOLFILE->set_clear_len 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_MPOOLFILE->set_clear_len function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_MPOOLFILE->set_clear_len function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/memp_set_fileid.html b/db/docs/api_c/memp_set_fileid.html index 90a73171a..2bfb51996 100644 --- a/db/docs/api_c/memp_set_fileid.html +++ b/db/docs/api_c/memp_set_fileid.html @@ -1,6 +1,7 @@ -<!--Id: memp_set_fileid.so,v 10.2 2001/10/22 15:24:36 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_set_fileid.so,v 10.4 2002/06/24 14:49:27 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_MPOOLFILE->set_fileid</title> @@ -51,32 +52,37 @@ using the Berkeley DB access methods instead of calling the pool functions explicitly, or if the files in the memory pool are stored on filesystems in which the default values as described previously are invariant between process and across system reboots. +<p>The DB_MPOOLFILE->set_fileid function configures a file in the memory pool, not only +operations performed using the specified <a href="../api_c/memp_fcreate.html">DB_MPOOLFILE</a> handle. +<p>The DB_MPOOLFILE->set_fileid interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> +interface is called. <p>The DB_MPOOLFILE->set_fileid function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_MPOOLFILE->set_fileid 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_MPOOLFILE->set_fileid function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_MPOOLFILE->set_fileid function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/memp_set_ftype.html b/db/docs/api_c/memp_set_ftype.html index 512cb34ef..19b81b6be 100644 --- a/db/docs/api_c/memp_set_ftype.html +++ b/db/docs/api_c/memp_set_ftype.html @@ -1,6 +1,7 @@ -<!--Id: memp_set_ftype.so,v 10.2 2001/10/22 15:24:37 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_set_ftype.so,v 10.4 2002/06/24 14:49:27 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_MPOOLFILE->set_ftype</title> @@ -31,32 +32,40 @@ written to, the backing filesystem store. The <b>ftype</b> argument must be the same as a <b>ftype</b> argument previously specified to the <a href="../api_c/memp_register.html">DB_ENV->memp_register</a> function. (See the <a href="../api_c/memp_register.html">DB_ENV->memp_register</a> documentation for more information.) +<p>The DB_MPOOLFILE->set_ftype function configures a file in the memory pool, not only +operations performed using the specified <a href="../api_c/memp_fcreate.html">DB_MPOOLFILE</a> handle. +<p>The DB_MPOOLFILE->set_ftype interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_ftype +will replace the existing information. <p>The DB_MPOOLFILE->set_ftype function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_MPOOLFILE->set_ftype 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_MPOOLFILE->set_ftype function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_MPOOLFILE->set_ftype function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/memp_set_lsn_offset.html b/db/docs/api_c/memp_set_lsn_offset.html index 40941e6ea..fbc6e8a22 100644 --- a/db/docs/api_c/memp_set_lsn_offset.html +++ b/db/docs/api_c/memp_set_lsn_offset.html @@ -1,6 +1,7 @@ -<!--Id: memp_set_lsn_offset.so,v 10.2 2001/10/22 15:24:37 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_set_lsn_offset.so,v 10.4 2002/06/24 14:49:28 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_MPOOLFILE->set_lsn_offset</title> @@ -29,32 +30,41 @@ DB_MPOOLFILE->set_lsn_offset(DB_MPOOLFILE *mpf, int32_t lsn_offset); of a log sequence number (<a href="../api_c/db_lsn.html">DB_LSN</a>) on the file's pages, for the purposes of page-flushing as part of transaction checkpoint. (See the <a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a> documentation for more information.) +<p>The DB_MPOOLFILE->set_lsn_offset function configures a file in the memory pool, not only +operations performed using the specified <a href="../api_c/memp_fcreate.html">DB_MPOOLFILE</a> handle. +<p>The DB_MPOOLFILE->set_lsn_offset interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_lsn_offset +must be consistent with the existing file or an error will be +returned. <p>The DB_MPOOLFILE->set_lsn_offset function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_MPOOLFILE->set_lsn_offset 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_MPOOLFILE->set_lsn_offset function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_MPOOLFILE->set_lsn_offset function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/memp_set_pgcookie.html b/db/docs/api_c/memp_set_pgcookie.html index bcfaa8e12..7e9e76133 100644 --- a/db/docs/api_c/memp_set_pgcookie.html +++ b/db/docs/api_c/memp_set_pgcookie.html @@ -1,6 +1,7 @@ -<!--Id: memp_set_pgcookie.so,v 10.2 2001/10/22 15:24:37 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: memp_set_pgcookie.so,v 10.4 2002/06/24 14:49:28 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_MPOOLFILE->set_pgcookie</title> @@ -30,32 +31,40 @@ to the functions registered to do input or output processing of the file's pages as they are read from or written to, the backing filesystem store. (See the <a href="../api_c/memp_register.html">DB_ENV->memp_register</a> documentation for more information.) +<p>The DB_MPOOLFILE->set_pgcookie function configures a file in the memory pool, not only +operations performed using the specified <a href="../api_c/memp_fcreate.html">DB_MPOOLFILE</a> handle. +<p>The DB_MPOOLFILE->set_pgcookie interface may not be called after the <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a> is called, the information specified to DB_MPOOLFILE->set_pgcookie +will replace the existing information. <p>The DB_MPOOLFILE->set_pgcookie function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_MPOOLFILE->set_pgcookie 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_MPOOLFILE->set_pgcookie function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_MPOOLFILE->set_pgcookie function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a>, <a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, +<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, +<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>, +<p> <a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a>, <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a>, <a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a>, <a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a>, <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a>, <a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a>, -<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>, -<a href="../api_c/memp_register.html">DB_ENV->memp_register</a>, -<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a>, +<a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a>, <a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a>, <a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a>, -<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a>, -<a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a>, -<a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a>, +<a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a> and -<a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a>. +<a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> diff --git a/db/docs/api_c/rep_elect.html b/db/docs/api_c/rep_elect.html index 609eae899..76b396dc3 100644 --- a/db/docs/api_c/rep_elect.html +++ b/db/docs/api_c/rep_elect.html @@ -1,6 +1,7 @@ -<!--Id: rep_elect.so,v 1.4 2001/10/26 13:57:00 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: rep_elect.so,v 1.6 2002/06/24 14:49:30 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->rep_elect</title> @@ -64,13 +65,13 @@ incoming messages is necessary to successfully complete an election. <p><dt>DB_REP_UNAVAIL<dd>The replication group was unable to elect a master. </dl> <p>The DB_ENV->rep_elect 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->rep_elect function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->rep_elect function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/rep_start.html">DB_ENV->rep_start</a>, <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>, -<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a>, +<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a> and <a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a>. </tt> diff --git a/db/docs/api_c/rep_message.html b/db/docs/api_c/rep_message.html index ef61b5e49..56d7c8078 100644 --- a/db/docs/api_c/rep_message.html +++ b/db/docs/api_c/rep_message.html @@ -1,6 +1,7 @@ -<!--Id: rep_message.so,v 1.4 2001/10/25 20:15:23 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: rep_message.so,v 1.9 2002/07/02 15:22:24 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->rep_process_message</title> @@ -40,37 +41,43 @@ information). processed using the same <a href="../api_c/env_create.html">DB_ENV</a> handle. It is not required that a single thread of control process all messages, only that all threads of control processing messages use the same handle. -<p>The DB_ENV->rep_process_message function may return one of several special conditions: -<p><dl compact> -<p><dt><a name="DB_REP_DUPMASTER">DB_REP_DUPMASTER</a><dd>The replication group has more than one master; the application should -reconfigure itself as a client by calling the <a href="../api_c/rep_start.html">DB_ENV->rep_start</a> function, and -then call for an election by calling <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>. -<p><dt><a name="DB_REP_HOLDELECTION">DB_REP_HOLDELECTION</a><dd>An election is needed, the application should call for an election by -calling <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>. -<p><dt><a name="DB_REP_NEWMASTER">DB_REP_NEWMASTER</a><dd>A new master has been elected. The memory location referenced by the -<b>envid</b> parameter contains the environment ID of the new master. -If the recipient of this error return has been made master, it is the -application's responsibility to begin acting as the master environment. -<p><dt><a name="DB_REP_NEWSITE">DB_REP_NEWSITE</a><dd>The system received contact information from a new environment. The -<b>rec</b> parameter contains the opaque data specified in the +<p> +If a new master has been elected, the DB_ENV->rep_process_message function will return DB_REP_NEWMASTER. +The <b>envid</b> parameter contains the environment ID of the new +master. If the recipient of this error return has been made master, it +is the application's responsibility to begin acting as the master +environment. +<p> +If the system received contact information from a new environment, the DB_ENV->rep_process_message function will return DB_REP_NEWSITE. +The <b>rec</b> parameter contains the opaque data specified in the <b>cdata</b> parameter to the <a href="../api_c/rep_start.html">DB_ENV->rep_start</a>. The application should take whatever action is needed to establish a communication channel with this new environment. -<p><dt><a name="DB_REP_OUTDATED">DB_REP_OUTDATED</a><dd>The current environment's logs are too far out of date with respect to -the master to be automatically synchronized. The application should -copy over a hot backup of the environment, run recovery, and restart -the client. -</dl> -<p>Otherwise, the DB_ENV->rep_process_message function returns a non-zero error value on failure and 0 on success. +<p> +If the replication group has more than one master, the DB_ENV->rep_process_message function will return DB_REP_DUPMASTER. +The application should reconfigure itself as a client by calling the +<a href="../api_c/rep_start.html">DB_ENV->rep_start</a> function, and then call for an election by calling +<a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>. +<p> +If an election is needed, the DB_ENV->rep_process_message function will return DB_REP_HOLDELECTION. +The application should call for an election by +calling <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>. +<p> +If the current environment's logs are too far out of date with respect +to the master to be automatically synchronized, the DB_ENV->rep_process_message function will return DB_REP_OUTDATED. The +application should copy over a hot backup of the environment, run +recovery, and restart the client. +<p> +Otherwise, the DB_ENV->rep_process_message function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_ENV->rep_process_message 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->rep_process_message function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->rep_process_message function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/rep_start.html">DB_ENV->rep_start</a>, <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>, -<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a>, +<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a> and <a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a>. </tt> diff --git a/db/docs/api_c/rep_start.html b/db/docs/api_c/rep_start.html index b4b7be4c5..ab320ccbd 100644 --- a/db/docs/api_c/rep_start.html +++ b/db/docs/api_c/rep_start.html @@ -1,6 +1,7 @@ -<!--Id: rep_start.so,v 1.2 2001/10/25 14:08:43 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: rep_start.so,v 1.3 2002/06/24 14:49:30 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->rep_start</title> @@ -56,13 +57,13 @@ replication group by a call to <a href="../api_c/rep_transport.html">DB_ENV-> <p>The environment was not already opened. </dl> <p>The DB_ENV->rep_start 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->rep_start function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->rep_start function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/rep_start.html">DB_ENV->rep_start</a>, <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>, -<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a>, +<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a> and <a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a>. </tt> diff --git a/db/docs/api_c/rep_transport.html b/db/docs/api_c/rep_transport.html index ac3d59f18..dd935940a 100644 --- a/db/docs/api_c/rep_transport.html +++ b/db/docs/api_c/rep_transport.html @@ -1,6 +1,7 @@ -<!--Id: rep_transport.so,v 1.4 2001/10/26 23:51:06 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: rep_transport.so,v 1.7 2002/06/24 14:49:30 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_ENV->set_rep_transport</title> @@ -51,7 +52,7 @@ The special identifier DB_EID_BROADCAST indicates that a message should be broadcast to every environment in the replication group. The application may use a true broadcast protocol, or may send the message in sequence to each machine with which it is in communication. -<p><dt>flag<dd> +<p><dt>flags<dd> <p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or more of the following values: <p><dl compact> @@ -70,17 +71,21 @@ otherwise, any error from the <b>send</b> interface will be ignored. <p>It may sometimes be useful to pass application-specific data to the <b>send</b> interface; see <a href="../ref/env/faq.html">Environment FAQ</a> for a discussion on how to do this. -<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>The DB_ENV->set_rep_transport function configures operations performed using the specified +<a href="../api_c/env_create.html">DB_ENV</a> handle, not all operations performed on the underlying +database environment. +<p>The DB_ENV->set_rep_transport interface may be called at any time during the life of +the application. <p>The DB_ENV->set_rep_transport function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_ENV->set_rep_transport 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_rep_transport function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_ENV->set_rep_transport function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/rep_start.html">DB_ENV->rep_start</a>, <a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a>, -<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a>, +<a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a> and <a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a>. </tt> diff --git a/db/docs/api_c/txn_set_timeout.html b/db/docs/api_c/txn_set_timeout.html index 4bd06a7a6..6c008523c 100644 --- a/db/docs/api_c/txn_set_timeout.html +++ b/db/docs/api_c/txn_set_timeout.html @@ -1,6 +1,7 @@ -<!--Id: txn_set_timeout.so,v 10.3 2001/10/22 15:24:39 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: txn_set_timeout.so,v 10.6 2002/06/24 14:49:36 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_TXN->set_timeout</title> @@ -46,6 +47,11 @@ is performed, the accuracy of the timeout depends on how often deadlock detection is performed. <p>Timeout values may be specified for the database environment as a whole. See <a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a> and for more information. +<p>The DB_TXN->set_timeout function configures operations performed on the underlying +transaction, not only operations performed using the specified +<a href="../api_c/txn_begin.html">DB_TXN</a> handle. +<p>The DB_TXN->set_timeout interface may be called at any time during the life of +the application. <p>The DB_TXN->set_timeout function returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB_TXN->set_timeout function may fail and return a non-zero error for the following conditions: @@ -53,24 +59,25 @@ See <a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a> and for m <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p>The DB_TXN->set_timeout 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_TXN->set_timeout function may fail and return -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. +If a catastrophic error has occurred, the DB_TXN->set_timeout function may fail and +return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_c/env_set_tx_max.html">DB_ENV->set_tx_max</a>, -<a href="../api_c/env_set_tx_recover.html">DB_ENV->set_tx_recover</a>, <a href="../api_c/env_set_tx_timestamp.html">DB_ENV->set_tx_timestamp</a>, -<a href="../api_c/txn_abort.html">DB_TXN->abort</a>, <a href="../api_c/txn_begin.html">DB_ENV->txn_begin</a>, <a href="../api_c/txn_checkpoint.html">DB_ENV->txn_checkpoint</a>, +<a href="../api_c/txn_recover.html">DB_ENV->txn_recover</a> +and +<a href="../api_c/txn_stat.html">DB_ENV->txn_stat</a>. +<p> +<a href="../api_c/txn_abort.html">DB_TXN->abort</a>, <a href="../api_c/txn_commit.html">DB_TXN->commit</a>, <a href="../api_c/txn_discard.html">DB_TXN->discard</a>, <a href="../api_c/txn_id.html">DB_TXN->id</a>, -<a href="../api_c/txn_prepare.html">DB_TXN->prepare</a>, -<a href="../api_c/txn_recover.html">DB_ENV->txn_recover</a>, -<a href="../api_c/txn_set_timeout.html">DB_TXN->set_timeout</a> +<a href="../api_c/txn_prepare.html">DB_TXN->prepare</a> and -<a href="../api_c/txn_stat.html">DB_ENV->txn_stat</a>. +<a href="../api_c/txn_set_timeout.html">DB_TXN->set_timeout</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> |