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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB_TXN->set_timeout()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="txn.html" title="Chapter 12. The DB_TXN Handle" />
<link rel="prev" href="txnset_priority.html" title="DB_TXN->set_priority()" />
<link rel="next" href="utilities.html" title="Appendix A. Berkeley DB Command Line Utilities" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_TXN->set_timeout()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="txnset_priority.html">Prev</a> </td>
<th width="60%" align="center">Chapter 12.
The DB_TXN Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="utilities.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="txnset_timeout"></a>DB_TXN->set_timeout()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
u_int32_t
DB_TXN->set_timeout(DB_TXN *tid, db_timeout_t timeout, u_int32_t flags); </pre>
<p>
The <code class="methodname">DB_TXN->set_timeout()</code> method sets timeout values for locks or
transactions for the specified transaction.
</p>
<p>
Timeouts are checked whenever a thread of control blocks on a lock or
when deadlock detection is performed. In the case of
<code class="literal">DB_SET_LOCK_TIMEOUT</code>, the timeout is for any single lock request. In
the case of <code class="literal">DB_SET_TXN_TIMEOUT</code>, the timeout is for the life of the
transaction. As timeouts are only checked when the lock request first
blocks or when deadlock detection is performed, the accuracy of the
timeout depends on how often deadlock detection is performed.
</p>
<p>
Timeout values may be specified for the database environment as a
whole. See <a class="xref" href="envset_timeout.html" title="DB_ENV->set_timeout()">DB_ENV->set_timeout()</a> and
for more information.
</p>
<p>
The <code class="methodname">DB_TXN->set_timeout()</code> method configures operations performed on
the underlying transaction, not only operations performed using the
specified <a class="link" href="txn.html" title="Chapter 12. The DB_TXN Handle">DB_TXN</a> handle.
</p>
<p>
The <code class="methodname">DB_TXN->set_timeout()</code> method may be called at any time during the
life of the application.
</p>
<p>
The <code class="methodname">DB_TXN->set_timeout()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54658944"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54650504"></a>timeout</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>timeout</strong></span> parameter is specified as
an unsigned 32-bit number of microseconds, limiting the maximum
timeout to roughly 71 minutes. A value of 0 disables timeouts for the
transaction.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54663528"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to
one of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_SET_LOCK_TIMEOUT</code>
</p>
<p>
Set the timeout value for locks in this transaction.
</p>
</li>
<li>
<p>
<code class="literal">DB_SET_TXN_TIMEOUT</code>
</p>
<p>
Set the timeout value for this transaction.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54679064"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_TXN->set_timeout()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54683616"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54682752"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>, <a class="link" href="txn.html" title="Chapter 12. The DB_TXN Handle">DB_TXN</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54684176"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="txnset_priority.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="txn.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="utilities.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_TXN->set_priority() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Appendix A.
Berkeley DB Command Line Utilities
</td>
</tr>
</table>
</div>
</body>
</html>
|
