diff options
Diffstat (limited to 'db/docs/api_c/txn_prepare.html')
| -rw-r--r-- | db/docs/api_c/txn_prepare.html | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/db/docs/api_c/txn_prepare.html b/db/docs/api_c/txn_prepare.html new file mode 100644 index 000000000..549a6f074 --- /dev/null +++ b/db/docs/api_c/txn_prepare.html @@ -0,0 +1,63 @@ +<!--$Id: txn_prepare.so,v 10.17 2000/12/31 19:26:21 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley 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><tr valign=top> +<td> +<h1>txn_prepare</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_prepare(DB_TXN *tid); +</pre></h3> +<h1>Description</h1> +<p>The txn_prepare function 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 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 a parent transaction +causes all unresolved children of the parent transaction to be prepared. +<p>The txn_prepare function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_prepare function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_prepare function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.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> |