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
|
<?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>DbEnv::get_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="env.html" title="Chapter 5. The DbEnv Handle" />
<link rel="prev" href="envget_thread_count.html" title="DbEnv::get_thread_count()" />
<link rel="next" href="envget_tmp_dir.html" title="DbEnv::get_tmp_dir()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::get_timeout()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envget_thread_count.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envget_tmp_dir.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="envget_timeout"></a>DbEnv::get_timeout()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::get_timeout(db_timeout_t *timeoutp, u_int32_t flag);</pre>
<p>
The <code class="methodname">DbEnv::get_timeout()</code> method returns a value, in
microseconds, representing either lock or transaction timeouts. These values are set using the
<a class="xref" href="envset_timeout.html" title="DbEnv::set_timeout()">DbEnv::set_timeout()</a>
method.
</p>
<p>
The <code class="methodname">DbEnv::get_timeout()</code> method may be called at any time during the
life of the application.
</p>
<p>
The <code class="methodname">DbEnv::get_timeout()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6936128"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6935480"></a>timeoutp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>timeoutp</strong></span> parameter references
memory into which the timeout value of the specified <span class="bold"><strong>flag</strong></span> parameter is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6929768"></a>flag</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><a id="get_timeout_DB_SET_LOCK_TIMEOUT"></a>
<code class="literal">DB_SET_LOCK_TIMEOUT</code>
</p>
<p>
Return the timeout value for locks in this database environment.
</p>
</li>
<li>
<p><a id="get_timeout_DB_SET_REG_TIMEOUT"></a>
<code class="literal">DB_SET_REG_TIMEOUT</code>
</p>
<p>
Return the timeout value for how long to wait for
processes to exit the environment before
recovery is started. This flag only has meaning
when the <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>
method was called with the
<a class="link" href="envopen.html#envopen_DB_REGISTER">DB_REGISTER</a>
flag and recovery must be performed.
</p>
</li>
<li>
<p><a id="get_timeout_DB_SET_TXN_TIMEOUT"></a>
<code class="literal">DB_SET_TXN_TIMEOUT</code>
</p>
<p>
Return the timeout value for transactions in this database
environment.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6943952"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6939880"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>,
<a class="xref" href="envset_timeout.html" title="DbEnv::set_timeout()">DbEnv::set_timeout()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envget_thread_count.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envget_tmp_dir.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::get_thread_count() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::get_tmp_dir()</td>
</tr>
</table>
</div>
</body>
</html>
|
