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
|
<!--$Id: txn_prepare.html,v 1.1.1.1 2003/11/20 22:14:27 toshok Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_TXN->prepare</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>DB_TXN->prepare</h1>
</td>
<td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
int
DB_TXN->prepare(DB_TXN *tid, u_int8_t gid[DB_XIDDATASIZE]);
</pre></h3>
<h1>Description</h1>
<a name="3"><!--meow--></a>
<p>The DB_TXN->prepare method initiates the beginning of a two-phase commit.
<p>In a distributed transaction environment, Berkeley DB can be used as a local
transaction manager. In this case, the distributed transaction manager
must send <i>prepare</i> messages to each local manager. The local
manager must then issue a DB_TXN->prepare and await its successful
return before responding to the distributed transaction manager. Only
after the distributed transaction manager receives successful responses
from all of its <i>prepare</i> messages should it issue any
<i>commit</i> messages.
<p>In the case of nested transactions, preparing the parent
causes all unresolved children of the parent transaction to be committed.
Child transactions should never be explicitly prepared.
Their fate will be resolved along with their parent's during
global recovery.
<p>The <b>gid</b> parameter specifies the global transaction ID by which this
transaction will be known. This global transaction ID will be returned
in calls to <a href="../api_c/txn_recover.html">DB_ENV->txn_recover</a>, telling the application which global
transactions must be resolved.
<p>The DB_TXN->prepare method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The DB_TXN->prepare method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB_TXN->prepare method may fail and
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/txn_class.html">DB_TXN</a>
<h1>See Also</h1>
<a href="../api_c/txn_list.html">Transaction Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|
