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_cxx | |
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_cxx')
-rw-r--r-- | db/docs/api_cxx/c_index.html | 41 | ||||
-rw-r--r-- | db/docs/api_cxx/env_set_timeout.html | 42 | ||||
-rw-r--r-- | db/docs/api_cxx/lock_id_free.html | 15 | ||||
-rw-r--r-- | db/docs/api_cxx/log_cursor.html | 24 | ||||
-rw-r--r-- | db/docs/api_cxx/logc_class.html | 27 | ||||
-rw-r--r-- | db/docs/api_cxx/logc_close.html | 47 | ||||
-rw-r--r-- | db/docs/api_cxx/logc_get.html | 84 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_fcreate.html | 28 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_set_clear_len.html | 36 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_set_fileid.html | 32 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_set_ftype.html | 35 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_set_lsn_offset.html | 36 | ||||
-rw-r--r-- | db/docs/api_cxx/memp_set_pgcookie.html | 35 | ||||
-rw-r--r-- | db/docs/api_cxx/rep_elect.html | 15 | ||||
-rw-r--r-- | db/docs/api_cxx/rep_message.html | 59 | ||||
-rw-r--r-- | db/docs/api_cxx/rep_start.html | 15 | ||||
-rw-r--r-- | db/docs/api_cxx/rep_transport.html | 23 | ||||
-rw-r--r-- | db/docs/api_cxx/txn_set_timeout.html | 31 |
18 files changed, 361 insertions, 264 deletions
diff --git a/db/docs/api_cxx/c_index.html b/db/docs/api_cxx/c_index.html index 8aba44c15..3958b8f0a 100644 --- a/db/docs/api_cxx/c_index.html +++ b/db/docs/api_cxx/c_index.html @@ -1,24 +1,31 @@ -<!--Id: c_index.so,v 10.80 2001/10/13 19:56:20 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: c_index.so,v 10.96 2002/07/24 05:06:08 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> -<title>Berkeley DB: C++ Interface</title> +<title>Berkeley DB: Berkeley DB: C++ Interface</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> -<h1 align=center>C++ Interface</h1> +<h1 align=center>Berkeley DB: C++ Interface</h1> <p><table border=1 align=center> <tr><th>Section</th><th>Class/Method</th><th>Description</th></tr> <tr><td><b>Database Environment</b></td><td><a href="../api_cxx/dbenv_class.html">DbEnv</a></td><td>Create an environment handle</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_close.html">DbEnv::close</a></td><td>Close an environment</td></tr> +<tr><td><br></td><td><a href="../api_cxx/env_dbremove.html">DbEnv::dbremove</a></td><td>Remove a database</td></tr> +<tr><td><br></td><td><a href="../api_cxx/env_dbrename.html">DbEnv::dbrename</a></td><td>Rename a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_err.html">DbEnv::err</a></td><td>Error message with error string</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_err.html">DbEnv::errx</a></td><td>Error message</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_open.html">DbEnv::open</a></td><td>Open an environment</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_remove.html">DbEnv::remove</a></td><td>Remove an environment</td></tr> +<tr><td><br></td><td><a href="../api_cxx/env_strerror.html">DbEnv::strerror</a></td><td>Error strings</td></tr> +<tr><td><br></td><td><a href="../api_cxx/env_version.html">DbEnv::version</a></td><td>Return version information</td></tr> +<tr><td><b>Environment Configuration</b></td><td><a href="../api_cxx/env_set_app_dispatch.html">DbEnv::set_app_dispatch</a></td><td>Configure application recovery interface</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_alloc.html">DbEnv::set_alloc</a></td><td>Set local space allocation functions</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a></td><td>Set the environment data directory</td></tr> +<tr><td><br></td><td><a href="../api_cxx/env_set_encrypt.html">DbEnv::set_encrypt</a></td><td>Set the environment cryptographic key</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a></td><td>Set error message callback</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a></td><td>Set error message FILE</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a></td><td>Set error message output stream</td></tr> @@ -26,19 +33,18 @@ <tr><td><br></td><td><a href="../api_cxx/env_set_feedback.html">DbEnv::set_feedback</a></td><td>Set feedback callback</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a></td><td>Environment configuration</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a></td><td>Set panic callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_rec_init.html">DbEnv::set_recovery_init</a></td><td>Set recovery initialization callback</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_rpc_server.html">DbEnv::set_rpc_server</a></td><td>Establish an RPC server connection</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_shm_key.html">DbEnv::set_shm_key</a></td><td>Set system memory shared segment ID</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_tas_spins.html">DbEnv::set_tas_spins</a></td><td>Set the number of test-and-set spins</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_tmp_dir.html">DbEnv::set_tmp_dir</a></td><td>Set the environment temporary file directory</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_timeout.html">DbEnv::set_timeout</a></td><td>Set lock and transaction timeout</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a></td><td>Set verbose messages</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_strerror.html">DbEnv::strerror</a></td><td>Error strings</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_version.html">DbEnv::version</a></td><td>Return version information</td></tr> <tr><td><b>Database Operations</b></td><td><a href="../api_cxx/db_class.html">Db</a></td><td>Create a database handle</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_associate.html">Db::associate</a></td><td>Associate a secondary index</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_close.html">Db::close</a></td><td>Close a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_del.html">Db::del</a></td><td>Delete items from a database</td></tr> +<tr><td><br></td><td><a href="../api_cxx/db_err.html">Db::err</a></td><td>Error message with error string</td></tr> +<tr><td><br></td><td><a href="../api_cxx/db_err.html">Db::errx</a></td><td>Error message</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_fd.html">Db::fd</a></td><td>Return a file descriptor from a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_get.html">Db::get</a>, <a href="../api_cxx/db_get.html">Db::pget</a></td><td>Get items from a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a></td><td>Return if the underlying database is in host order</td></tr> @@ -54,16 +60,17 @@ <tr><td><br></td><td><a href="../api_cxx/db_truncate.html">Db::truncate</a></td><td>Empty a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_upgrade.html">Db::upgrade</a></td><td>Upgrade a database</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_verify.html">Db::verify</a></td><td>Verify/salvage a database</td></tr> -<tr><td><b>Database Configuration</b></td><td><a href="../api_cxx/db_err.html">Db::err</a></td><td>Error message with error string</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_err.html">Db::errx</a></td><td>Error message</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_alloc.html">Db::set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><b>Database Configuration</b></td><td><a href="../api_cxx/db_set_alloc.html">Db::set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><br></td><td><a href="../api_cxx/db_set_cache_priority.html">Db::set_cache_priority</a></td><td>Set the database cache priority</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a></td><td>Set the database cache size</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a></td><td>Set a duplicate comparison function</td></tr> +<tr><td><br></td><td><a href="../api_cxx/db_set_encrypt.html">Db::set_encrypt</a></td><td>Set the database cryptographic key</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a></td><td>Set error message callback</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a></td><td>Set error message FILE</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a></td><td>Set error message prefix</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_feedback.html">Db::set_feedback</a></td><td>Set feedback callback</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_flags.html">Db::set_flags</a></td><td>General database configuration</td></tr> +<tr><td><br></td><td><a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a></td><td>Set the database byte order</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a></td><td>Set the underlying database page size</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a></td><td>Set panic callback</td></tr> <tr><td><b>Btree/Recno Configuration</b></td><td><a href="../api_cxx/db_set_append_recno.html">Db::set_append_recno</a></td><td>Set record append callback</td></tr> @@ -77,7 +84,6 @@ <tr><td><b>Hash Configuration</b></td><td><a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a></td><td>Set the Hash table density</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a></td><td>Set a hashing function</td></tr> <tr><td><br></td><td><a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a></td><td>Set the Hash table size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a></td><td>Set the database byte order</td></tr> <tr><td><b>Queue Configuration</b></td><td><a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a></td><td>Set Queue database extent size</td></tr> <tr><td><b>Database Cursor Operations</b></td><td><a href="../api_cxx/dbc_class.html">Dbc</a></td><td><b>Cursor class</b></td></tr> <tr><td><br></td><td><a href="../api_cxx/db_cursor.html">Db::cursor</a></td><td>Create a cursor handle</td></tr> @@ -109,13 +115,11 @@ <tr><td><br></td><td><a href="../api_cxx/log_file.html">DbEnv::log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> <tr><td><br></td><td><a href="../api_cxx/log_flush.html">DbEnv::log_flush</a></td><td>Flush log records</td></tr> <tr><td><br></td><td><a href="../api_cxx/log_put.html">DbEnv::log_put</a></td><td>Write a log record</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_register.html">DbEnv::log_register</a></td><td>Register a filename with the log manager</td></tr> <tr><td><br></td><td><a href="../api_cxx/log_stat.html">DbEnv::log_stat</a></td><td>Return log subsystem statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a></td><td>Unregister a filename with the log manager</td></tr> <tr><td><b>Log Cursor Operations</b></td><td><a href="../api_cxx/logc_class.html">DbLogc</a></td><td><b>Log cursor class</b></td></tr> <tr><td><br></td><td><a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a></td><td>Create a log cursor handle</td></tr> -<tr><td><br></td><td><a href="../api_cxx/logc_close.html">DbLogc::logc_close</a></td><td>Close a log cursor</td></tr> -<tr><td><br></td><td><a href="../api_cxx/logc_get.html">DbLogc::logc_get</a></td><td>Retrieve a log record</td></tr> +<tr><td><br></td><td><a href="../api_cxx/logc_close.html">DbLogc::close</a></td><td>Close a log cursor</td></tr> +<tr><td><br></td><td><a href="../api_cxx/logc_get.html">DbLogc::get</a></td><td>Retrieve a log record</td></tr> <tr><td><b>Log Sequence Numbers</b></td><td><a href="../api_cxx/lsn_class.html">DbLsn</a></td><td><br></td></tr> <tr><td><br></td><td><a href="../api_cxx/log_compare.html">DbEnv::log_compare</a></td><td>Compare two Log Sequence Numbers</td></tr> <tr><td><b>Memory Pool Subsystem</b></td><td><a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a></td><td>Set the environment cache size</td></tr> @@ -138,7 +142,6 @@ <tr><td><br></td><td><a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a></td><td>Set file log-sequence-number offset</td></tr> <tr><td><br></td><td><a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a></td><td>Set file cookie for pgin/pgout</td></tr> <tr><td><b>Transaction Subsystem</b></td><td><a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a></td><td>Set maximum number of transactions</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a></td><td>Set transaction abort recover function</td></tr> <tr><td><br></td><td><a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> <tr><td><br></td><td><a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> <tr><td><br></td><td><a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a></td><td>Distributed transaction recovery</td></tr> @@ -153,13 +156,17 @@ <tr><td><br></td><td><a href="../api_cxx/txn_set_timeout.html">DbTxn::set_timeout</a></td><td>Set transaction timeout</td></tr> <tr><td><b>Replication</b></td><td><a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a></td><td>Configure replication transport</td></tr> <tr><td><br></td><td><a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><br></td><td><a href="../api_cxx/rep_limit.html">DbEnv::set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> <tr><td><br></td><td><a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a></td><td>Process a replication message</td></tr> <tr><td><br></td><td><a href="../api_cxx/rep_start.html">DbEnv::rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><br></td><td><a href="../api_cxx/rep_stat.html">DbEnv::rep_stat</a></td><td>Replication statistics</td></tr> <tr><td><b>Exceptions</b></td><td><a href="../api_cxx/except_class.html">DbException</a></td><td><b>Exception Class for Berkeley DB Activity</b></td></tr> <tr><td><br></td><td><a href="../api_cxx/get_errno.html">DbException::get_errno</a></td><td>Get the error value</td></tr> <tr><td><br></td><td><a href="../api_cxx/what.html">DbException::what</a></td><td>Get the error string</td></tr> +<tr><td><br></td><td><a href="../api_cxx/deadlock_class.html">DbDeadlockException</a></td><td><b>Exception Class for deadlocks</b></td></tr> +<tr><td><br></td><td><a href="../api_cxx/lockng_class.html">DbLockNotGrantedException</a></td><td><b>Exception Class for lock request failures</b></td></tr> <tr><td><br></td><td><a href="../api_cxx/mem_class.html">DbMemoryException</a></td><td><b>Exception Class for insufficient memory</b></td></tr> -<tr><td><br></td><td><a href="../api_cxx/get_dbt.html">DbMemoryException::get_dbt</a></td><td>Get the failing Dbt</td></tr> +<tr><td><br></td><td><a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a></td><td><b>Exception Class for failures requiring recovery</b></td></tr> </table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> diff --git a/db/docs/api_cxx/env_set_timeout.html b/db/docs/api_cxx/env_set_timeout.html index a04ec7d33..26a6b719c 100644 --- a/db/docs/api_cxx/env_set_timeout.html +++ b/db/docs/api_cxx/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: DbEnv::set_timeout</title> @@ -59,44 +60,61 @@ 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_cxx/lock_vec.html">DbEnv::lock_vec</a> and <a href="../api_cxx/txn_set_timeout.html">DbTxn::set_timeout</a> for more information. -<p>The DbEnv::set_timeout interface may be used only to configure Berkeley DB before -the <a href="../api_cxx/env_open.html">DbEnv::open</a> interface is called. +<p>The DbEnv::set_timeout method configures a database environment, not only operations +performed using the specified <a href="../api_cxx/dbenv_class.html">DbEnv</a> handle. +<p>The DbEnv::set_timeout interface may be called at any time during the life of +the application. <p>The DbEnv::set_timeout 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. <h1>Errors</h1> <p>The DbEnv::set_timeout method may fail and throw an exception or 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_cxx/env_open.html">DbEnv::open</a> was called. </dl> <p>The DbEnv::set_timeout 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::set_timeout method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::set_timeout method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a> <h1>See Also</h1> <a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_err.html">DbEnv::err</a>, <a href="../api_cxx/env_err.html">DbEnv::errx</a> +<a href="../api_cxx/env_dbremove.html">DbEnv::dbremove</a>, +<a href="../api_cxx/env_dbrename.html">DbEnv::dbrename</a>, +<a href="../api_cxx/env_err.html">DbEnv::err</a>, +<a href="../api_cxx/env_err.html">DbEnv::errx</a>, <a href="../api_cxx/env_open.html">DbEnv::open</a>, <a href="../api_cxx/env_remove.html">DbEnv::remove</a>, <a href="../api_cxx/env_set_alloc.html">DbEnv::set_alloc</a>, +<a href="../api_cxx/env_set_app_dispatch.html">DbEnv::set_app_dispatch</a>, <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a>, +<a href="../api_cxx/env_set_encrypt.html">DbEnv::set_encrypt</a>, <a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, <a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, <a href="../api_cxx/env_set_feedback.html">DbEnv::set_feedback</a>, <a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, +<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, +<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, +<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, +<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, +<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, +<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, +<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, +<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, +<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, +<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, <a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -<a href="../api_cxx/env_set_rec_init.html">DbEnv::set_recovery_init</a>, <a href="../api_cxx/env_set_rpc_server.html">DbEnv::set_rpc_server</a>, <a href="../api_cxx/env_set_shm_key.html">DbEnv::set_shm_key</a>, <a href="../api_cxx/env_set_tas_spins.html">DbEnv::set_tas_spins</a>, -<a href="../api_cxx/env_set_tmp_dir.html">DbEnv::set_tmp_dir</a>, <a href="../api_cxx/env_set_timeout.html">DbEnv::set_timeout</a>, +<a href="../api_cxx/env_set_tmp_dir.html">DbEnv::set_tmp_dir</a>, +<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, +<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, <a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>, <a href="../api_cxx/env_strerror.html">DbEnv::strerror</a> and diff --git a/db/docs/api_cxx/lock_id_free.html b/db/docs/api_cxx/lock_id_free.html index e6e8f8f36..ee463e484 100644 --- a/db/docs/api_cxx/lock_id_free.html +++ b/db/docs/api_cxx/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: DbEnv::lock_id_free</title> @@ -35,10 +36,10 @@ encapsulates a non-zero error value on failure, and returns 0 on success. <p>The locker ID is invalid or locks are still held by this locker ID. </dl> <p>The DbEnv::lock_id_free 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_id_free method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::lock_id_free method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> <h1>See Also</h1> @@ -52,7 +53,7 @@ in the same way. <a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, <a href="../api_cxx/lock_id_free.html">DbEnv::lock_id_free</a>, <a href="../api_cxx/lock_put.html">DbEnv::lock_put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a>, +<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> and <a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. </tt> diff --git a/db/docs/api_cxx/log_cursor.html b/db/docs/api_cxx/log_cursor.html index b6a877ba3..083920d55 100644 --- a/db/docs/api_cxx/log_cursor.html +++ b/db/docs/api_cxx/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: DbEnv::log_cursor</title> @@ -37,36 +38,39 @@ encapsulates a non-zero error value on failure, and returns 0 on success. <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p>The DbEnv::log_cursor 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::log_cursor method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::log_cursor method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/db_class.html">Db</a> <h1>See Also</h1> +<a href="../api_cxx/db_set_alloc.html">Db::set_alloc</a>, <a href="../api_cxx/db_associate.html">Db::associate</a>, <a href="../api_cxx/db_close.html">Db::close</a>, <a href="../api_cxx/db_cursor.html">Db::cursor</a>, <a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, <a href="../api_cxx/db_err.html">Db::errx</a> +<a href="../api_cxx/db_err.html">Db::err</a>, +<a href="../api_cxx/db_err.html">Db::errx</a>, <a href="../api_cxx/db_fd.html">Db::fd</a>, <a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get.html">Db::pget</a>, <a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, <a href="../api_cxx/db_get_type.html">Db::get_type</a>, <a href="../api_cxx/db_join.html">Db::join</a>, <a href="../api_cxx/db_key_range.html">Db::key_range</a>, <a href="../api_cxx/db_open.html">Db::open</a>, +<a href="../api_cxx/db_get.html">Db::pget</a>, <a href="../api_cxx/db_put.html">Db::put</a>, <a href="../api_cxx/db_remove.html">Db::remove</a>, <a href="../api_cxx/db_rename.html">Db::rename</a>, -<a href="../api_cxx/db_set_alloc.html">Db::set_alloc</a>, <a href="../api_cxx/db_set_append_recno.html">Db::set_append_recno</a>, <a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, <a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, <a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, +<a href="../api_cxx/db_set_cache_priority.html">Db::set_cache_priority</a>, <a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, <a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, +<a href="../api_cxx/db_set_encrypt.html">Db::set_encrypt</a>, <a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, <a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, <a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, @@ -86,7 +90,7 @@ in the same way. <a href="../api_cxx/db_stat.html">Db::stat</a>, <a href="../api_cxx/db_sync.html">Db::sync</a>, <a href="../api_cxx/db_truncate.html">Db::truncate</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a>, +<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> and <a href="../api_cxx/db_verify.html">Db::verify</a>. </tt> diff --git a/db/docs/api_cxx/logc_class.html b/db/docs/api_cxx/logc_class.html index c83c12e95..de5b7d81b 100644 --- a/db/docs/api_cxx/logc_class.html +++ b/db/docs/api_cxx/logc_class.html @@ -1,6 +1,7 @@ -<!--Id: logc_class.so,v 1.1 2001/09/28 15:09:37 bostic Exp --> -<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--Id: logc_class.so,v 1.3 2002/06/27 19:10:06 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbLogc</title> @@ -30,24 +31,24 @@ which provides cursor support for log files. sequential access to the records stored in log files. Cursors are created by calling the <a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a> method which returns a pointer to a DbLogc object. <h1>Class</h1> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> +<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a> <h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, <a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, <a href="../api_cxx/log_file.html">DbEnv::log_file</a>, <a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, <a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, <a href="../api_cxx/log_stat.html">DbEnv::log_stat</a>, -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>, -<a href="../api_cxx/logc_close.html">DbLogc::logc_close</a> +<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, +<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, +<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, +<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, +and +<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>. +<p> +<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, +<a href="../api_cxx/logc_close.html">DbLogc::close</a> and -<a href="../api_cxx/logc_get.html">DbLogc::logc_get</a>. +<a href="../api_cxx/logc_get.html">DbLogc::get</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/logc_close.html b/db/docs/api_cxx/logc_close.html index b3ad0fc69..20c55bb79 100644 --- a/db/docs/api_cxx/logc_close.html +++ b/db/docs/api_cxx/logc_close.html @@ -1,9 +1,10 @@ -<!--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: DbLogc::logc_close</title> +<title>Berkeley DB: DbLogc::close</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> @@ -11,7 +12,7 @@ <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> -<h1>DbLogc::logc_close</h1> +<h1>DbLogc::close</h1> </td> <td align=right> <a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> @@ -25,42 +26,42 @@ int DbLogc::close(u_int32_t flags); </pre></h3> <h1>Description</h1> -<p>The DbLogc::logc_close method discards the log cursor. After DbLogc::logc_close +<p>The DbLogc::close method discards the log cursor. After DbLogc::close has been called, regardless of its return, the cursor handle may not be used again. <p>The <b>flags</b> parameter is currently unused, and must be set to 0. -<p>The DbLogc::logc_close method either returns a non-zero error value or throws an exception that +<p>The DbLogc::close 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. <h1>Errors</h1> -<p>The DbLogc::logc_close method may fail and throw an exception or return a non-zero error for the following conditions: +<p>The DbLogc::close method may fail and throw an exception or 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>The cursor was previously closed. </dl> -<p>The DbLogc::logc_close 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 DbLogc::logc_close method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. +<p>The DbLogc::close 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 DbLogc::close method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> +<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a> <h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, <a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, <a href="../api_cxx/log_file.html">DbEnv::log_file</a>, <a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, <a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, <a href="../api_cxx/log_stat.html">DbEnv::log_stat</a>, -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>, -<a href="../api_cxx/logc_close.html">DbLogc::logc_close</a> +<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, +<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, +<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, +<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, +and +<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>. +<p> +<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, +<a href="../api_cxx/logc_close.html">DbLogc::close</a> and -<a href="../api_cxx/logc_get.html">DbLogc::logc_get</a>. +<a href="../api_cxx/logc_get.html">DbLogc::get</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/logc_get.html b/db/docs/api_cxx/logc_get.html index 73d6e9f46..cbfef46d0 100644 --- a/db/docs/api_cxx/logc_get.html +++ b/db/docs/api_cxx/logc_get.html @@ -1,9 +1,10 @@ -<!--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: DbLogc::logc_get</title> +<title>Berkeley DB: DbLogc::get</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> @@ -11,7 +12,7 @@ <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> -<h1>DbLogc::logc_get</h1> +<h1>DbLogc::get</h1> </td> <td align=right> <a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> @@ -25,7 +26,7 @@ int DbLogc::get(DbLsn *lsn, Dbt *data, u_int32_t flags); </pre></h3> <h1>Description</h1> -<p>The DbLogc::logc_get method retrieve records from the log according to the +<p>The DbLogc::get method retrieve records from the log according to the <b>lsn</b> and <b>flags</b> arguments. <p>The data field of the <b>data</b> structure is set to the record retrieved, and the size field indicates the number of bytes in the @@ -35,44 +36,41 @@ record. See <a href="../api_cxx/dbt_class.html">Dbt</a> for a description of ot for any <a href="../api_cxx/dbt_class.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_cxx/log_put.html">DbEnv::log_put</a> method is returned in the <b>data</b> argument. The -<b>lsn</b> argument is overwritten with the <a href="../api_cxx/lsn_class.html">DbLsn</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 DbLogc::logc_get method 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_cxx/lsn_class.html">DbLsn</a> of the record returned. -<p>If the log is empty, the DbLogc::logc_get method will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p> +If the log is empty, the DbLogc::get method 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_cxx/lsn_class.html">DbLsn</a> of the record returned. -<p>If the log is empty, the DbLogc::logc_get method will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p> +If the log is empty, the DbLogc::get method 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_cxx/lsn_class.html">DbLsn</a> of the record returned. -<p>If the pointer has not been initialized via DB_FIRST, DB_LAST, DB_SET, -DB_NEXT, or DB_PREV, DbLogc::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 DbLogc::logc_get method 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 -DbLogc::logc_get with the DB_NEXT (DB_PREV) flag set will return -EINVAL. +<p>If the cursor has not been initialized via DB_FIRST, DB_LAST, DB_SET, +DB_NEXT, or DB_PREV, DbLogc::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 DbLogc::get method will return DB_NOTFOUND. +If the log was opened with the DB_THREAD flag set, calls to +DbLogc::get with the DB_NEXT (DB_PREV) flag set, the DbLogc::get method either returns EINVAL or throws an exception that encapsulates 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, DbLogc::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_cxx/lsn_class.html">DbLsn</a> is invalid (for example, it does not appear in -the log) DbLogc::logc_get will return EINVAL. +flag set, the DbLogc::get method either returns EINVAL or throws an exception that encapsulates 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_cxx/lsn_class.html">DbLsn</a> is invalid (for example, it does not +appear in the log), the DbLogc::get method either returns EINVAL or throws an exception that encapsulates EINVAL. </dl> -<p>Otherwise, the DbLogc::logc_get method either returns a non-zero error value or throws an exception that +<p> +Otherwise, the DbLogc::get 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. <h1>Errors</h1> -<p>The DbLogc::logc_get method may fail and throw an exception or return a non-zero error for the following conditions: +<p>The DbLogc::get method may fail and throw an exception or 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>The DB_CURRENT flag was set and the log pointer had not yet been @@ -80,30 +78,30 @@ initialized. <p>The DB_SET flag was set and the specified log sequence number does not exist. </dl> -<p>The DbLogc::logc_get 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 DbLogc::logc_get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. +<p>The DbLogc::get 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 DbLogc::get method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> +<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a> <h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, <a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, <a href="../api_cxx/log_file.html">DbEnv::log_file</a>, <a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, <a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, <a href="../api_cxx/log_stat.html">DbEnv::log_stat</a>, -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>, -<a href="../api_cxx/logc_close.html">DbLogc::logc_close</a> +<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, +<a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a>, +<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, +<a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a>, +and +<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>. +<p> +<a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a>, +<a href="../api_cxx/logc_close.html">DbLogc::close</a> and -<a href="../api_cxx/logc_get.html">DbLogc::logc_get</a>. +<a href="../api_cxx/logc_get.html">DbLogc::get</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_fcreate.html b/db/docs/api_cxx/memp_fcreate.html index 6a6a202f3..25da222d0 100644 --- a/db/docs/api_cxx/memp_fcreate.html +++ b/db/docs/api_cxx/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: DbEnv::memp_fcreate</title> @@ -34,32 +35,33 @@ Calling the <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a> method encapsulates a non-zero error value on failure, and returns 0 on success. <h1>Errors</h1> <p>The DbEnv::memp_fcreate 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::memp_fcreate method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::memp_fcreate method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_set_clear_len.html b/db/docs/api_cxx/memp_set_clear_len.html index 56017cc18..98ed67676 100644 --- a/db/docs/api_cxx/memp_set_clear_len.html +++ b/db/docs/api_cxx/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: DbMpoolFile::set_clear_len</title> @@ -30,36 +31,45 @@ page that should be set to nul when the page is created as a result of the <a href="../api_cxx/memp_fget.html#DB_MPOOL_CREATE">DB_MPOOL_CREATE</a> or <a href="../api_cxx/memp_fget.html#DB_MPOOL_NEW">DB_MPOOL_NEW</a> flags being specified to <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>. If no value is specified, or <b>len</b> is 0, the entire page is cleared. +<p>The DbMpoolFile::set_clear_len method configures a file in the memory pool, not only +operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle. +<p>The DbMpoolFile::set_clear_len interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_clear_len +must be consistent with the existing file or an error will be +returned. <p>The DbMpoolFile::set_clear_len 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. <h1>Errors</h1> <p>The DbMpoolFile::set_clear_len 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 DbMpoolFile::set_clear_len method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbMpoolFile::set_clear_len method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_set_fileid.html b/db/docs/api_cxx/memp_set_fileid.html index 50c179a2e..d63738fcc 100644 --- a/db/docs/api_cxx/memp_set_fileid.html +++ b/db/docs/api_cxx/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: DbMpoolFile::set_fileid</title> @@ -51,36 +52,41 @@ 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 DbMpoolFile::set_fileid method configures a file in the memory pool, not only +operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle. +<p>The DbMpoolFile::set_fileid interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> +interface is called. <p>The DbMpoolFile::set_fileid 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. <h1>Errors</h1> <p>The DbMpoolFile::set_fileid 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 DbMpoolFile::set_fileid method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbMpoolFile::set_fileid method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_set_ftype.html b/db/docs/api_cxx/memp_set_ftype.html index 04195c00a..7dd394def 100644 --- a/db/docs/api_cxx/memp_set_ftype.html +++ b/db/docs/api_cxx/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: DbMpoolFile::set_ftype</title> @@ -31,36 +32,44 @@ 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_cxx/memp_register.html">DbEnv::memp_register</a> method. (See the <a href="../api_cxx/memp_register.html">DbEnv::memp_register</a> documentation for more information.) +<p>The DbMpoolFile::set_ftype method configures a file in the memory pool, not only +operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle. +<p>The DbMpoolFile::set_ftype interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_ftype +will replace the existing information. <p>The DbMpoolFile::set_ftype 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. <h1>Errors</h1> <p>The DbMpoolFile::set_ftype 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 DbMpoolFile::set_ftype method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbMpoolFile::set_ftype method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_set_lsn_offset.html b/db/docs/api_cxx/memp_set_lsn_offset.html index 05891ba4c..74c76d4f8 100644 --- a/db/docs/api_cxx/memp_set_lsn_offset.html +++ b/db/docs/api_cxx/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: DbMpoolFile::set_lsn_offset</title> @@ -29,36 +30,45 @@ DbMpoolFile::set(int32_t lsn_offset); of a log sequence number (<a href="../api_cxx/lsn_class.html">DbLsn</a>) on the file's pages, for the purposes of page-flushing as part of transaction checkpoint. (See the <a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> documentation for more information.) +<p>The DbMpoolFile::set_lsn_offset method configures a file in the memory pool, not only +operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle. +<p>The DbMpoolFile::set_lsn_offset interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_lsn_offset +must be consistent with the existing file or an error will be +returned. <p>The DbMpoolFile::set_lsn_offset 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. <h1>Errors</h1> <p>The DbMpoolFile::set_lsn_offset 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 DbMpoolFile::set_lsn_offset method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbMpoolFile::set_lsn_offset method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/memp_set_pgcookie.html b/db/docs/api_cxx/memp_set_pgcookie.html index 945f729f0..6c89916e8 100644 --- a/db/docs/api_cxx/memp_set_pgcookie.html +++ b/db/docs/api_cxx/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: DbMpoolFile::set_pgcookie</title> @@ -30,36 +31,44 @@ 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_cxx/memp_register.html">DbEnv::memp_register</a> documentation for more information.) +<p>The DbMpoolFile::set_pgcookie method configures a file in the memory pool, not only +operations performed using the specified <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle. +<p>The DbMpoolFile::set_pgcookie interface may not be called after the <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> +interface is called. +If the file is already open in the memory pool when +<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> is called, the information specified to DbMpoolFile::set_pgcookie +will replace the existing information. <p>The DbMpoolFile::set_pgcookie 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. <h1>Errors</h1> <p>The DbMpoolFile::set_pgcookie 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 DbMpoolFile::set_pgcookie method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbMpoolFile::set_pgcookie method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> <h1>See Also</h1> <a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, <a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, +<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, +<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, +<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>, +<p> <a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a>, <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, <a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a>, +<a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a>, <a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a>, <a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a>, -<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a>, +<a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a> and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. +<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/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_cxx/rep_elect.html b/db/docs/api_cxx/rep_elect.html index 7aac497e7..a15408235 100644 --- a/db/docs/api_cxx/rep_elect.html +++ b/db/docs/api_cxx/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: DbEnv::rep_elect</title> @@ -65,14 +66,14 @@ encapsulates a non-zero error value on failure, and returns 0 on success. <p><dt>DB_REP_UNAVAIL<dd>The replication group was unable to elect a master. </dl> <p>The DbEnv::rep_elect 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::rep_elect method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::rep_elect method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>, <a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>, -<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a>, +<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a> and <a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a>. </tt> diff --git a/db/docs/api_cxx/rep_message.html b/db/docs/api_cxx/rep_message.html index 4004c3f0e..a11cd9566 100644 --- a/db/docs/api_cxx/rep_message.html +++ b/db/docs/api_cxx/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: DbEnv::rep_process_message</title> @@ -39,39 +40,45 @@ information). processed using the same <a href="../api_cxx/dbenv_class.html">DbEnv</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 DbEnv::rep_process_message method 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_cxx/rep_start.html">DbEnv::rep_start</a> method, and -then call for an election by calling <a href="../api_cxx/rep_elect.html">DbEnv::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_cxx/rep_elect.html">DbEnv::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 DbEnv::rep_process_message method 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 DbEnv::rep_process_message method 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_cxx/rep_start.html">DbEnv::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 DbEnv::rep_process_message method either returns a non-zero error value or throws an exception that +<p> +If the replication group has more than one master, the DbEnv::rep_process_message method either returns DB_REP_DUPMASTER or throws an exception that encapsulates DB_REP_DUPMASTER. +The application should reconfigure itself as a client by calling the +<a href="../api_cxx/rep_start.html">DbEnv::rep_start</a> method, and then call for an election by calling +<a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>. +<p> +If an election is needed, the DbEnv::rep_process_message method either returns DB_REP_HOLDELECTION or throws an exception that encapsulates DB_REP_HOLDELECTION. +The application should call for an election by +calling <a href="../api_cxx/rep_elect.html">DbEnv::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 DbEnv::rep_process_message method either returns DB_REP_OUTDATED or throws an exception that encapsulates DB_REP_OUTDATED. The +application should copy over a hot backup of the environment, run +recovery, and restart the client. +<p> +Otherwise, the DbEnv::rep_process_message 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. <h1>Errors</h1> <p>The DbEnv::rep_process_message 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::rep_process_message method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::rep_process_message method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>, <a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>, -<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a>, +<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a> and <a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a>. </tt> diff --git a/db/docs/api_cxx/rep_start.html b/db/docs/api_cxx/rep_start.html index 3be75a427..7a81b6fcf 100644 --- a/db/docs/api_cxx/rep_start.html +++ b/db/docs/api_cxx/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: DbEnv::rep_start</title> @@ -57,14 +58,14 @@ replication group by a call to <a href="../api_cxx/rep_transport.html">DbEnv::se <p>The environment was not already opened. </dl> <p>The DbEnv::rep_start 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::rep_start method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::rep_start method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>, <a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>, -<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a>, +<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a> and <a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a>. </tt> diff --git a/db/docs/api_cxx/rep_transport.html b/db/docs/api_cxx/rep_transport.html index 6998e11cd..19fb8d233 100644 --- a/db/docs/api_cxx/rep_transport.html +++ b/db/docs/api_cxx/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: DbEnv::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,19 +71,23 @@ 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 DbEnv::set_rep_transport method configures operations performed using the specified +<a href="../api_cxx/dbenv_class.html">DbEnv</a> handle, not all operations performed on the underlying +database environment. +<p>The DbEnv::set_rep_transport interface may be called at any time during the life of +the application. <p>The DbEnv::set_rep_transport 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. <h1>Errors</h1> <p>The DbEnv::set_rep_transport 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::set_rep_transport method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbEnv::set_rep_transport method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>See Also</h1> <a href="../api_cxx/rep_start.html">DbEnv::rep_start</a>, <a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a>, -<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a>, +<a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a> and <a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a>. </tt> diff --git a/db/docs/api_cxx/txn_set_timeout.html b/db/docs/api_cxx/txn_set_timeout.html index f67020601..29e675587 100644 --- a/db/docs/api_cxx/txn_set_timeout.html +++ b/db/docs/api_cxx/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: DbTxn::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_cxx/env_set_timeout.html">DbEnv::set_timeout</a> and for more information. +<p>The DbTxn::set_timeout method configures operations performed on the underlying +transaction, not only operations performed using the specified +<a href="../api_cxx/txn_class.html">DbTxn</a> handle. +<p>The DbTxn::set_timeout interface may be called at any time during the life of +the application. <p>The DbTxn::set_timeout 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. <h1>Errors</h1> @@ -54,27 +60,28 @@ encapsulates a non-zero error value on failure, and returns 0 on success. <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p>The DbTxn::set_timeout 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 DbTxn::set_timeout method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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 DbTxn::set_timeout method may fail and +either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a +<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>, +in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> <h1>See Also</h1> <a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, <a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, <a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, +<a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a> +and +<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. +<p> +<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, <a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, <a href="../api_cxx/txn_discard.html">DbTxn::discard</a>, <a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a>, -<a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a>, -<a href="../api_cxx/txn_set_timeout.html">DbTxn::set_timeout</a> +<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. +<a href="../api_cxx/txn_set_timeout.html">DbTxn::set_timeout</a>. </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> |