1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<!--$Id: txn_recover.html,v 1.1.1.1 2003/11/20 22:14:30 toshok Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::txn_recover</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>DbEnv::txn_recover</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>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbEnv::txn_recover(DB_PREPLIST preplist[],
long count, long *retp, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DbEnv::txn_recover interface returns a list of prepared but not
yet resolved transactions. The DbEnv::txn_recover method should only be
called after the environment has been recovered. Because database
environment state must be preserved between recovery and the application
calling DbEnv::txn_recover, applications must either call
DbEnv::txn_recover using the same environment handle used when recovery
is done, or the database environment must not be configured using the
<a href="../api_cxx/env_open.html#DB_PRIVATE">DB_PRIVATE</a> flag.
<p>On return from DbEnv::txn_recover, the <b>preplist</b> argument will
be filled in with a list of transactions that must be resolved by the
application (committed, aborted or discarded). The <b>preplist</b>
argument is a structure of type DB_PREPLIST; the following DB_PREPLIST
fields will be filled in:
<p><dl compact>
<p><dt>DB_TXN *txn;<dd>The transaction handle for the transaction.
<p><dt>u_int8_t gid[<a href="../api_cxx/txn_prepare.html#DB_XIDDATASIZE">DB_XIDDATASIZE</a>];<dd>The global transaction ID for the transaction. The global transaction
ID is the one specified when the transaction was prepared. The
application is responsible for ensuring uniqueness among global
transaction IDs.
</dl>
<p>The application must call <a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, <a href="../api_cxx/txn_commit.html">DbTxn::commit</a> or
<a href="../api_cxx/txn_discard.html">DbTxn::discard</a> on each returned <a href="../api_cxx/txn_class.html">DbTxn</a> handle before
starting any new operations.
<p>The <b>count</b> parameter specifies the number of available entries
in the passed-in <b>preplist</b> array. The <b>retp</b> parameter
returns the number of entries DbEnv::txn_recover has filled in, in the
array.
<p>The <b>flags</b> value must be set to one of the following values:
<p><dl compact>
<p><dt><a name="DB_FIRST">DB_FIRST</a><dd>Begin returning a list of prepared, but not yet resolved transactions.
<p><dt><a name="DB_NEXT">DB_NEXT</a><dd>Continue returning a list of prepared, but not yet resolved transactions,
starting where the last call to DbEnv::txn_recover left off.
</dl>
<p>The DbEnv::txn_recover 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::txn_recover 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::txn_recover 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/env_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a>
<h1>See Also</h1>
<a href="../api_cxx/txn_list.html">Transaction Subsystem and Related Methods</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>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|
