diff options
Diffstat (limited to 'db/docs/api_java/logc_get.html')
-rw-r--r-- | db/docs/api_java/logc_get.html | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/db/docs/api_java/logc_get.html b/db/docs/api_java/logc_get.html new file mode 100644 index 000000000..2269a8a4b --- /dev/null +++ b/db/docs/api_java/logc_get.html @@ -0,0 +1,112 @@ +<!--Id: logc_get.so,v 10.30 2001/09/29 15:48:08 dda Exp --> +<!--Copyright 1997-2001 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DbLogc.logc_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> +<body bgcolor=white> +<a name="2"><!--meow--></a> +<table width="100%"><tr valign=top> +<td> +<h1>DbLogc.logc_get</h1> +</td> +<td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +import com.sleepycat.db.*; +<p> +public int get(DbLsn lsn, Dbt data, int flags) + throws DbException; +</pre></h3> +<h1>Description</h1> +<p>The DbLogc.logc_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 +record. See <a href="../api_java/dbt_class.html">Dbt</a> for a description of other fields in the +<b>data</b> structure. The <a href="../api_java/dbt_class.html#DB_DBT_MALLOC">Db.DB_DBT_MALLOC</a>, +<a href="../api_java/dbt_class.html#DB_DBT_REALLOC">Db.DB_DBT_REALLOC</a> and <a href="../api_java/dbt_class.html#DB_DBT_USERMEM">Db.DB_DBT_USERMEM</a> flags may be specified +for any <a href="../api_java/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.DB_CHECKPOINT">Db.DB_CHECKPOINT</a><dd>The last record written with the DB_CHECKPOINT flag specified to the +<a href="../api_java/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_java/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.DB_NOTFOUND</a>. +<p><dt><a name="Db.DB_FIRST">Db.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_java/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.DB_NOTFOUND</a>. +<p><dt><a name="Db.DB_LAST">Db.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_java/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.DB_NOTFOUND</a>. +<p><dt><a name="Db.DB_NEXT">Db.DB_NEXT</a>, <a name="Db.DB_PREV">Db.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_java/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.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><dt><a name="Db.DB_CURRENT">Db.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, +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.DB_SET">Db.DB_SET</a><dd>Retrieve the record specified by the <b>lsn</b> argument. If the +specified <a href="../api_java/lsn_class.html">DbLsn</a> is invalid (for example, it does not appear in +the log) DbLogc.logc_get will return EINVAL. +</dl> +<p>Otherwise, the DbLogc.logc_get method throws an exception that encapsulates a non-zero error value on +failure. +<h1>Errors</h1> +<p>The DbLogc.logc_get method may fail and throw an exception encapsulating 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 +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 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 throw +a <a href="../api_java/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_java/dbenv_class.html">DbEnv</a> +<h1>See Also</h1> +<a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a>, +<a href="../api_java/env_set_lg_dir.html">DbEnv.set_lg_dir</a>, +<a href="../api_java/env_set_lg_max.html">DbEnv.set_lg_max</a>, +<a href="../api_java/env_set_lg_regionmax.html">DbEnv.set_lg_regionmax</a>, +<a href="../api_java/log_archive.html">DbEnv.log_archive</a>, +<a href="../api_java/log_compare.html">DbEnv.log_compare</a>, +<a href="../api_java/log_cursor.html">DbEnv.log_cursor</a>, +<a href="../api_java/log_file.html">DbEnv.log_file</a>, +<a href="../api_java/log_flush.html">DbEnv.log_flush</a>, +<a href="../api_java/log_put.html">DbEnv.log_put</a>, +<a href="../api_java/log_register.html">DbEnv.log_register</a>, +<a href="../api_java/log_stat.html">DbEnv.log_stat</a>, +<a href="../api_java/log_unregister.html">DbEnv.log_unregister</a>, +<a href="../api_java/logc_close.html">DbLogc.logc_close</a> +and +<a href="../api_java/logc_get.html">DbLogc.logc_get</a>. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> |