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
|
<!--$Id: env_set_feedback.so,v 10.43 2006/05/17 20:47:46 bostic Exp $-->
<!--Copyright 1997-2006 by Oracle Corporation-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::set_feedback</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DbEnv::set_feedback</h3>
</td>
<td align=right>
<a href="../api_cxx/api_core.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_cxx.h>
<p>
int
DbEnv::set_feedback(void (*db_feedback_fcn)(DbEnv *dbenv, int opcode, int percent));
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::set_feedback</h3>
<p>Some operations performed by the Berkeley DB library can take non-trivial
amounts of time. The DbEnv::set_feedback method can be used by applications
to monitor progress within these operations. When an operation is
likely to take a long time, Berkeley DB will call the specified callback
function with progress information.</p>
<p>It is up to the callback function to display this information in an
appropriate manner.</p>
<p>The DbEnv::set_feedback method configures operations performed using the specified
<a href="../api_cxx/env_class.html">DbEnv</a> handle
<p>The DbEnv::set_feedback method may be called at any time during the life of the
application.</p>
<p>The DbEnv::set_feedback 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.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>db_feedback_fcn</b><dd>The <b>db_feedback_fcn</b> parameter is the application-specified
feedback function called to report Berkeley DB operation progress. The
callback function must take three parameters:
<dl compact>
<dt><b>dbenv</b><dd>The <b>dbenv</b> parameter is a reference to the enclosing database
environment.
<dt><b>opcode</b><dd>The <b>opcode</b> parameter is an operation code. The <b>opcode</b>
parameter may take on any of the following values:
<dl compact>
<dt><a name="DB_RECOVER">DB_RECOVER</a><dd>The environment is being recovered.
</dl>
<dt><b>percent</b><dd>The <b>percent</b> parameter is the percent of the operation that has
been completed, specified as an integer value between 0 and 100.
</dl>
<p>Berkeley DB is not re-entrant. Callback functions should not attempt to make
library calls (for example, to release locks or close open handles).
Re-entering Berkeley DB is not guaranteed to work correctly, and the results
are undefined.</p>
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/env_class.html">DbEnv</a>
<h3>See Also</h3>
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.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>Copyright (c) 1996-2006 Oracle Corporation - All rights reserved.</font>
</body>
</html>
|
