diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/Transaction.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/Transaction.html | 1161 |
1 files changed, 550 insertions, 611 deletions
diff --git a/docs/java/com/sleepycat/db/Transaction.html b/docs/java/com/sleepycat/db/Transaction.html index 767a0652..e5b8eaa0 100644 --- a/docs/java/com/sleepycat/db/Transaction.html +++ b/docs/java/com/sleepycat/db/Transaction.html @@ -1,107 +1,105 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:06 EDT 2012 --> -<TITLE> -Transaction (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:54 EST 2015 --> +<title>Transaction (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Transaction (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Transaction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/Transaction.html" target="_top"><B>FRAMES</B></A> - <A HREF="Transaction.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Transaction.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> <!-- ========= END OF TOP NAVBAR ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class Transaction</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Transaction</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>Transaction</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -The Transaction object is the handle for a transaction. Methods off the +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class Transaction" class="title">Class Transaction</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.Transaction</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Transaction</span> +extends java.lang.Object</pre> +<div class="block">The Transaction object is the handle for a transaction. Methods off the transaction handle are used to configure, abort and commit the transaction. Transaction handles are provided to other Berkeley DB methods in order to transactionally protect those operations. @@ -109,14 +107,14 @@ methods in order to transactionally protect those operations. Transaction handles are not free-threaded; transactions handles may be used by multiple threads, but only serially, that is, the application must serialize access to the handle. Once the -<A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort</CODE></A>, <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit</CODE></A> or -<A HREF="../../../com/sleepycat/db/Transaction.html#discard()"><CODE>Transaction.discard</CODE></A> +<a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort</code></a>, <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit</code></a> or +<a href="../../../com/sleepycat/db/Transaction.html#discard()"><code>Transaction.discard</code></a> methods are called, the handle may not be accessed again (except to retrieve the commit token), regardless of the success or failure of the method. In addition, parent transactions may not issue any Berkeley DB operations while they have active child transactions (child transactions that have -not yet been committed or aborted) except for <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A>, <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort</CODE></A> and <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit</CODE></A>. +not yet been committed or aborted) except for <a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a>, <a href="../../../com/sleepycat/db/Transaction.html#abort()"><code>Transaction.abort</code></a> and <a href="../../../com/sleepycat/db/Transaction.html#commit()"><code>Transaction.commit</code></a>. <p> To obtain a transaction with default attributes: <blockquote><pre> @@ -127,195 +125,166 @@ To customize the attributes of a transaction: TransactionConfig config = new TransactionConfig(); config.setDirtyRead(true); Transaction txn = myEnvironment.beginTransaction(null, config); -</pre></blockquote> -<P> - -<P> -<HR> - -<P> - +</pre></blockquote></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#abort()">abort</A></B>()</CODE> - -<BR> - Cause an abnormal termination of the transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#commit()">commit</A></B>()</CODE> - -<BR> - End the transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#commitNoSync()">commitNoSync</A></B>()</CODE> - -<BR> - End the transaction, not committing synchronously.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#commitSync()">commitSync</A></B>()</CODE> - -<BR> - End the transaction, committing synchronously.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#commitWriteNoSync()">commitWriteNoSync</A></B>()</CODE> - -<BR> - End the transaction, writing but not flushing the log.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#discard()">discard</A></B>()</CODE> - -<BR> - Free up all the per-process resources associated with the specified - <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle, neither committing nor aborting the - transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> byte[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#getCommitToken()">getCommitToken</A></B>()</CODE> - -<BR> - Fetch the transaction's commit token.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#getId()">getId</A></B>()</CODE> - -<BR> - Return the transaction's unique ID.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#getName()">getName</A></B>()</CODE> - -<BR> - Get the user visible name for the transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#getPriority()">getPriority</A></B>()</CODE> - -<BR> - Get the transaction's deadlock priority.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#prepare(byte[])">prepare</A></B>(byte[] gid)</CODE> - -<BR> - Initiate the beginning of a two-phase commit.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#setLockTimeout(long)">setLockTimeout</A></B>(long timeOut)</CODE> - -<BR> - Configure the lock request timeout value for the transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> - -<BR> - Set the user visible name for the transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#setPriority(int)">setPriority</A></B>(int priority)</CODE> - -<BR> - Set the deadlock priority for this transaction.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/Transaction.html#setTxnTimeout(long)">setTxnTimeout</A></B>(long timeOut)</CODE> - -<BR> - Configure the timeout value for the transaction lifetime.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#abort()">abort</a></strong>()</code> +<div class="block">Cause an abnormal termination of the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#commit()">commit</a></strong>()</code> +<div class="block">End the transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#commitNoSync()">commitNoSync</a></strong>()</code> +<div class="block">End the transaction, not committing synchronously.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#commitSync()">commitSync</a></strong>()</code> +<div class="block">End the transaction, committing synchronously.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#commitWriteNoSync()">commitWriteNoSync</a></strong>()</code> +<div class="block">End the transaction, writing but not flushing the log.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#discard()">discard</a></strong>()</code> +<div class="block">Free up all the per-process resources associated with the specified + <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle, neither committing nor aborting the + transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#getCommitToken()">getCommitToken</a></strong>()</code> +<div class="block">Fetch the transaction's commit token.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#getId()">getId</a></strong>()</code> +<div class="block">Return the transaction's unique ID.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#getName()">getName</a></strong>()</code> +<div class="block">Get the user visible name for the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">Get the transaction's deadlock priority.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#prepare(byte[])">prepare</a></strong>(byte[] gid)</code> +<div class="block">Initiate the beginning of a two-phase commit.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#setLockTimeout(long)">setLockTimeout</a></strong>(long timeOut)</code> +<div class="block">Configure the lock request timeout value for the transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set the user visible name for the transaction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#setPriority(int)">setPriority</a></strong>(int priority)</code> +<div class="block">Set the deadlock priority for this transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Transaction.html#setTxnTimeout(long)">setTxnTimeout</a></strong>(long timeOut)</code> +<div class="block">Configure the timeout value for the transaction lifetime.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> <!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="getCommitToken()"><!-- --></A><H3> -getCommitToken</H3> -<PRE> -public byte[] <B>getCommitToken</B>() - throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></PRE> -<DL> -<DD>Fetch the transaction's commit token. - <p> - This operation can only be performed after this transaction has committed. -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The commit token generated at the commit time of this transaction. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="abort()"><!-- --></A><H3> -abort</H3> -<PRE> -public void <B>abort</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Cause an abnormal termination of the transaction. +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getCommitToken()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCommitToken</h4> +<pre>public byte[] getCommitToken() + throws java.lang.IllegalStateException</pre> +<div class="block">Fetch the transaction's commit token. + <p> + This operation can only be performed after this transaction has committed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The commit token generated at the commit time of this transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd> +<dd><code>java.lang.IllegalStateException</code></dd></dl> +</li> +</ul> +<a name="abort()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>abort</h4> +<pre>public void abort() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Cause an abnormal termination of the transaction. <p> The log is played backward, and any necessary undo operations are done. Before Transaction.abort returns, any locks held by the transaction will @@ -327,30 +296,27 @@ public void <B>abort</B>() <p> All cursors opened within the transaction must be closed before the transaction is aborted. - This method closes all open <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles. + This method closes all open <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles. And if a close operation fails, the rest of the cursors are closed, and the database environment is set to the panic state. <p> After Transaction.abort has been called, regardless of its return, the - <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be accessed again. - <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="commit()"><!-- --></A><H3> -commit</H3> -<PRE> -public void <B>commit</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>End the transaction. If the environment is configured for synchronous + <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again. + <p> + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="commit()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commit</h4> +<pre>public void commit() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">End the transaction. If the environment is configured for synchronous commit, the transaction will be committed synchronously to stable storage before the call returns. This means the transaction will exhibit all of the ACID (atomicity, consistency, isolation, and durability) @@ -375,41 +341,38 @@ committed; and if its parent transaction aborts, it will be aborted. <p> All cursors opened within the transaction must be closed before the transaction is committed. -If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles +If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the transaction is aborted and the first such error is returned. <p> -After this method returns, the <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be +After this method returns, the <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again (except to retrieve the commit token), regardless of the method's success or failure. If the method encounters an error, the transaction and all child transactions of the transaction will have been aborted when the call returns. <p> -<p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="commitSync()"><!-- --></A><H3> -commitSync</H3> -<PRE> -public void <B>commitSync</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>End the transaction, committing synchronously. This means the +<p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="commitSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitSync</h4> +<pre>public void commitSync() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">End the transaction, committing synchronously. This means the transaction will exhibit all of the ACID (atomicity, consistency, isolation, and durability) properties. <p> This behavior is the default for database environments unless otherwise -configured using the <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnNoSync(boolean)"><CODE>EnvironmentConfig.setTxnNoSync</CODE></A> method. This +configured using the <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnNoSync(boolean)"><code>EnvironmentConfig.setTxnNoSync</code></a> method. This behavior may also be set for a single transaction using the -<A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> method. Any value specified to +<a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method. Any value specified to this method overrides both of those settings. <p> In the case of nested transactions, if the transaction is a parent @@ -424,34 +387,31 @@ committed; and if its parent transaction aborts, it will be aborted. <p> All cursors opened within the transaction must be closed before the transaction is committed. -If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles +If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the transaction is aborted and the first such error is returned. <p> -After this method returns, the <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be +After this method returns, the <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again (except to retrieve the commit token), regardless of the method's success or failure. If the method encounters an error, the transaction and all child transactions of the transaction will have been aborted when the call returns. <p> -<p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="commitNoSync()"><!-- --></A><H3> -commitNoSync</H3> -<PRE> -public void <B>commitNoSync</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>End the transaction, not committing synchronously. +<p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="commitNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitNoSync</h4> +<pre>public void commitNoSync() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">End the transaction, not committing synchronously. This means the transaction will exhibit the ACI (atomicity, consistency, and isolation) properties, but not D (durability); that is, database integrity will be @@ -459,8 +419,8 @@ maintained, but it is possible this transaction may be undone during recovery. <p> This behavior may be set for a database environment using the -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnNoSync(boolean)"><CODE>EnvironmentConfig.setTxnNoSync</CODE></A> method or for a single transaction -using the <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> method. Any value +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnNoSync(boolean)"><code>EnvironmentConfig.setTxnNoSync</code></a> method or for a single transaction +using the <a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method. Any value specified to this method overrides both of those settings. <p> In the case of nested transactions, if the transaction is a parent @@ -475,34 +435,31 @@ committed; and if its parent transaction aborts, it will be aborted. <p> All cursors opened within the transaction must be closed before the transaction is committed. -If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles +If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the transaction is aborted and the first such error is returned. <p> -After this method returns, the <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be +After this method returns, the <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again (except to retrieve the commit token), regardless of the method's success or failure. If the method encounters an error, the transaction and all child transactions of the transaction will have been aborted when the call returns. <p> -<p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="commitWriteNoSync()"><!-- --></A><H3> -commitWriteNoSync</H3> -<PRE> -public void <B>commitWriteNoSync</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>End the transaction, writing but not flushing the log. +<p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="commitWriteNoSync()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>commitWriteNoSync</h4> +<pre>public void commitWriteNoSync() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">End the transaction, writing but not flushing the log. This means the transaction will exhibit the ACI (atomicity, consistency, and isolation) properties, but not D (durability); that is, database integrity will be @@ -512,8 +469,8 @@ provides more durability than an asynchronous commit and has less performance cost than a synchronous commit. <p> This behavior may be set for a database environment using the -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnWriteNoSync(boolean)"><CODE>EnvironmentConfig.setTxnWriteNoSync</CODE></A> method or for a single -transaction using the <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A> method. +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#setTxnWriteNoSync(boolean)"><code>EnvironmentConfig.setTxnWriteNoSync</code></a> method or for a single +transaction using the <a href="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction,%20com.sleepycat.db.TransactionConfig)"><code>Environment.beginTransaction</code></a> method. Any value specified to this method overrides both of those settings. <p> In the case of nested transactions, if the transaction is a parent @@ -528,133 +485,118 @@ committed; and if its parent transaction aborts, it will be aborted. <p> All cursors opened within the transaction must be closed before the transaction is committed. -If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles +If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the transaction is aborted and the first such error is returned. <p> -After this method returns, the <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be +After this method returns, the <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again (except to retrieve the commit token), regardless of the method's success or failure. If the method encounters an error, the transaction and all child transactions of the transaction will have been aborted when the call returns. <p> -<p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="discard()"><!-- --></A><H3> -discard</H3> -<PRE> -public void <B>discard</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Free up all the per-process resources associated with the specified - <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle, neither committing nor aborting the +<p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="discard()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>discard</h4> +<pre>public void discard() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Free up all the per-process resources associated with the specified + <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle, neither committing nor aborting the transaction. This call may be used only after calls to - <A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)"><CODE>Environment.recover</CODE></A> when there are multiple global + <a href="../../../com/sleepycat/db/Environment.html#recover(int,%20boolean)"><code>Environment.recover</code></a> when there are multiple global transaction managers recovering transactions in a single database - environment. Any transactions returned by <A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)"><CODE>Environment.recover</CODE></A> that are not handled by the current global transaction + environment. Any transactions returned by <a href="../../../com/sleepycat/db/Environment.html#recover(int,%20boolean)"><code>Environment.recover</code></a> that are not handled by the current global transaction manager should be discarded using this method. - If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles + If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the first such error is returned. <p> - The <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> handle may not be accessed again after this + The <a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> handle may not be accessed again after this method has been called, regardless of the method's success or failure. <p> - <p> -<P> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getId()"><!-- --></A><H3> -getId</H3> -<PRE> -public int <B>getId</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return the transaction's unique ID. + <p></div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getId</h4> +<pre>public int getId() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return the transaction's unique ID. <p> Locking calls made on behalf of this transaction should use the value returned from this method as the locker parameter to the - <A HREF="../../../com/sleepycat/db/Environment.html#getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)"><CODE>Environment.getLock</CODE></A> or <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</CODE></A> + <a href="../../../com/sleepycat/db/Environment.html#getLock(int,%20boolean,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockRequestMode)"><code>Environment.getLock</code></a> or <a href="../../../com/sleepycat/db/Environment.html#lockVector(int,%20boolean,%20com.sleepycat.db.LockRequest[])"><code>Environment.lockVector</code></a> calls. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The transaction's unique ID. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getName()"><!-- --></A><H3> -getName</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Get the user visible name for the transaction. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The user visible name for the transaction. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="getPriority()"><!-- --></A><H3> -getPriority</H3> -<PRE> -public int <B>getPriority</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Get the transaction's deadlock priority. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The deadlock priority for the transaction. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs</DL> -</DD> -</DL> -<HR> - -<A NAME="prepare(byte[])"><!-- --></A><H3> -prepare</H3> -<PRE> -public void <B>prepare</B>(byte[] gid) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Initiate the beginning of a two-phase commit. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The transaction's unique ID. + <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Get the user visible name for the transaction. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The user visible name for the transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>public int getPriority() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Get the transaction's deadlock priority. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The deadlock priority for the transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd></dl> +</li> +</ul> +<a name="prepare(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prepare</h4> +<pre>public void prepare(byte[] gid) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Initiate 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 <em>prepare</em> messages to each local manager. The local manager must then issue a - <A HREF="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><CODE>Transaction.prepare</CODE></A> call and await its successful return + <a href="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><code>Transaction.prepare</code></a> call 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 <em>prepare</em> messages should it issue @@ -665,187 +607,184 @@ public void <B>prepare</B>(byte[] gid) Child transactions should never be explicitly prepared. Their fate will be resolved along with their parent's during global recovery. <p> - If there are <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> handles + If there are <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> handles open when this method is called, they are all closed inside this method. And if there are errors when closing the cursor handles, the first such error is returned. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>gid</CODE> - The global transaction ID by which this transaction will be known. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>gid</code> - The global transaction ID by which this transaction will be known. This global transaction ID will be returned in calls to - <A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)"><CODE>Environment.recover</CODE></A> method, telling the application which + <a href="../../../com/sleepycat/db/Environment.html#recover(int,%20boolean)"><code>Environment.recover</code></a> method, telling the application which global transactions must be resolved. The gid parameter must be sized at least DB_XIDDATASIZE (currently 128) bytes; only the first DB_XIDDATASIZE bytes are used. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="setName(java.lang.String)"><!-- --></A><H3> -setName</H3> -<PRE> -public void <B>setName</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Set the user visible name for the transaction. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>name</CODE> - The user visible name for the transaction. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="setPriority(int)"><!-- --></A><H3> -setPriority</H3> -<PRE> -public void <B>setPriority</B>(int priority) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Set the deadlock priority for this transaction. The deadlock detector will + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Set the user visible name for the transaction. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The user visible name for the transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl> +</li> +</ul> +<a name="setPriority(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPriority</h4> +<pre>public void setPriority(int priority) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Set the deadlock priority for this transaction. The deadlock detector will reject lock requests from lower priority transactions before those from higher priority transactions. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>priority</CODE> - The deadlock priority for the transaction. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="setTxnTimeout(long)"><!-- --></A><H3> -setTxnTimeout</H3> -<PRE> -public void <B>setTxnTimeout</B>(long timeOut) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Configure the timeout value for the transaction lifetime. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - The deadlock priority for the transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="setTxnTimeout(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTxnTimeout</h4> +<pre>public void setTxnTimeout(long timeOut) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Configure the timeout value for the transaction lifetime. <p> If the transaction runs longer than this time, the transaction may - may throw <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A>. + may throw <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a>. <p> Timeouts are checked whenever a thread of control blocks on a lock or when deadlock detection is performed. For this reason, the accuracy of the timeout depends on how often deadlock detection is performed. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>timeOut</CODE> - The timeout value for the transaction lifetime, in microseconds. As + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeOut</code> - The timeout value for the transaction lifetime, in microseconds. As the value is an unsigned 32-bit number of microseconds, the maximum timeout is roughly 71 minutes. A value of 0 disables timeouts for the transaction. <p> This method may be called at any time during the life of the application. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="setLockTimeout(long)"><!-- --></A><H3> -setLockTimeout</H3> -<PRE> -public void <B>setLockTimeout</B>(long timeOut) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Configure the lock request timeout value for the transaction. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="setLockTimeout(long)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setLockTimeout</h4> +<pre>public void setLockTimeout(long timeOut) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Configure the lock request timeout value for the transaction. <p> If a lock request cannot be granted in this time, the transaction - may throw <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A>. + may throw <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a>. <p> Timeouts are checked whenever a thread of control blocks on a lock or when deadlock detection is performed. For this reason, the accuracy of the timeout depends on how often deadlock detection is performed. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>timeOut</CODE> - The lock request timeout value for the transaction, in microseconds. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeOut</code> - The lock request timeout value for the transaction, in microseconds. As the value is an unsigned 32-bit number of microseconds, the maximum timeout is roughly 71 minutes. A value of 0 disables timeouts for the transaction. <p> This method may be called at any time during the life of the application. <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= END OF CLASS DATA ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Transaction.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/Transaction.html" target="_top"><B>FRAMES</B></A> - <A HREF="Transaction.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Transaction.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/Transaction.html" target="_top">Frames</a></li> +<li><a href="Transaction.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |