2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DB_TXN->set_timeout</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DB_TXN->set_timeout</h1>
18
<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>
26
DB_TXN->set_timeout(DB_TXN *tid, db_timeout_t timeout, u_int32_t flags);
29
<p>The DB_TXN->set_timeout method sets timeout values for locks or
30
transactions for the specified transaction. The timeout value is
31
currently specified as an unsigned 32-bit number of microseconds,
32
limiting the maximum timeout to roughly 71 minutes.
33
<p>The <b>flags</b> value must be set to one of the following values:
35
<p><dt><a name="DB_SET_LOCK_TIMEOUT">DB_SET_LOCK_TIMEOUT</a><dd>Set the timeout value for locks in this transaction.
36
<p><dt><a name="DB_SET_TXN_TIMEOUT">DB_SET_TXN_TIMEOUT</a><dd>Set the timeout value for this transaction.
38
<p>Timeouts are checked whenever a thread of control blocks on a lock or
39
when deadlock detection is performed. (In the case of
40
DB_SET_LOCK_TIMEOUT, the lock is one requested explicitly
41
through the Lock subsystem interfaces. In the case of
42
DB_SET_TXN_TIMEOUT, the lock is one requested on behalf of a
43
transaction. In either case, it may be a lock requested by the database
44
access methods underlying the application.) As timeouts are only
45
checked when the lock request first blocks or when deadlock detection
46
is performed, the accuracy of the timeout depends on how often deadlock
47
detection is performed.
48
<p>Timeout values may be specified for the database environment as a whole.
49
See <a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a> and for more information.
50
<p>The DB_TXN->set_timeout method configures operations performed on the underlying
51
transaction, not only operations performed using the specified
52
<a href="../api_c/txn_class.html">DB_TXN</a> handle.
53
<p>The DB_TXN->set_timeout interface may be called at any time during the life of
55
<p>The DB_TXN->set_timeout method returns a non-zero error value on failure and 0 on success.
57
<p>The DB_TXN->set_timeout method may fail and return a non-zero error for the following conditions:
59
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
61
<p>The DB_TXN->set_timeout method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
62
If a catastrophic error has occurred, the DB_TXN->set_timeout method may fail and
63
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
64
in which case all subsequent Berkeley DB calls will fail in the same way.
66
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/txn_class.html">DB_TXN</a>
68
<a href="../api_c/txn_list.html">Transaction Subsystem and Related Methods</a>
70
<table width="100%"><tr><td><br></td><td align=right>
71
<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>
73
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>