~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_java/db_set_feedback.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
ImportĀ upstreamĀ versionĀ 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!--$Id: db_set_feedback.so,v 10.17 2001/04/02 00:36:36 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: Db.set_feedback</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>Db.set_feedback</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
import com.sleepycat.db.*;
 
23
<p>
 
24
public interface DbFeedback
 
25
{
 
26
        public abstract void db_feedback(Db db, int opcode, int pct);
 
27
}
 
28
public class Db
 
29
{
 
30
        public void set_feedback(DbFeedback db_feedback)
 
31
                throws DbException;
 
32
        ...
 
33
}
 
34
</pre></h3>
 
35
<h1>Description</h1>
 
36
<p>Some operations performed by the Berkeley DB library can take non-trivial
 
37
amounts of time.  The Db.set_feedback method can be used by
 
38
applications to monitor progress within these operations.
 
39
<p>When an operation is likely to take a long time, Berkeley DB will call the
 
40
specified callback method.  This method must be declared with
 
41
three arguments: the first will be a reference to the enclosing database
 
42
handle; the second a flag value; and the third the percent of the
 
43
operation that has been completed, specified as an integer value between
 
44
0 and 100.  It is up to the callback method to display this
 
45
information in an appropriate manner.
 
46
<p>The <b>opcode</b> argument may take on any of the following values:
 
47
<p><dl compact>
 
48
<p><dt><a name="Db.DB_UPGRADE">Db.DB_UPGRADE</a><dd>The underlying database is being upgraded.
 
49
<p><dt><a name="Db.DB_VERIFY">Db.DB_VERIFY</a><dd>The underlying database is being verified.
 
50
</dl>
 
51
<p>The Db.set_feedback interface may be used to configure Berkeley DB at any time
 
52
during the life of the application.
 
53
<p>The Db.set_feedback method throws an exception that encapsulates a non-zero error value on
 
54
failure.
 
55
<h1>Class</h1>
 
56
<a href="../api_java/db_class.html">Db</a>
 
57
<h1>See Also</h1>
 
58
<a href="../api_java/db_associate.html">Db.associate</a>,
 
59
<a href="../api_java/db_close.html">Db.close</a>,
 
60
<a href="../api_java/db_cursor.html">Db.cursor</a>,
 
61
<a href="../api_java/db_del.html">Db.del</a>,
 
62
<a href="../api_java/db_fd.html">Db.fd</a>,
 
63
<a href="../api_java/db_get.html">Db.get</a>,
 
64
<a href="../api_java/db_get.html">Db.pget</a>,
 
65
<a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a>,
 
66
<a href="../api_java/db_get_type.html">Db.get_type</a>,
 
67
<a href="../api_java/db_join.html">Db.join</a>,
 
68
<a href="../api_java/db_key_range.html">Db.key_range</a>,
 
69
<a href="../api_java/db_open.html">Db.open</a>,
 
70
<a href="../api_java/db_put.html">Db.put</a>,
 
71
<a href="../api_java/db_remove.html">Db.remove</a>,
 
72
<a href="../api_java/db_rename.html">Db.rename</a>,
 
73
<a href="../api_java/db_set_append_recno.html">Db.set_append_recno</a>,
 
74
<a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>,
 
75
<a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a>,
 
76
<a href="../api_java/db_set_errcall.html">Db.set_errcall</a>,
 
77
<a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a>,
 
78
<a href="../api_java/db_set_feedback.html">Db.set_feedback</a>,
 
79
<a href="../api_java/db_set_flags.html">Db.set_flags</a>,
 
80
<a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>,
 
81
<a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a>,
 
82
<a href="../api_java/db_set_lorder.html">Db.set_lorder</a>,
 
83
<a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a>,
 
84
<a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>,
 
85
<a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a>,
 
86
<a href="../api_java/db_set_re_len.html">Db.set_re_len</a>,
 
87
<a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a>,
 
88
<a href="../api_java/db_set_re_source.html">Db.set_re_source</a>,
 
89
<a href="../api_java/db_stat.html">Db.stat</a>,
 
90
<a href="../api_java/db_sync.html">Db.sync</a>,
 
91
<a href="../api_java/db_truncate.html">Db.truncate</a>,
 
92
<a href="../api_java/db_upgrade.html">Db.upgrade</a>,
 
93
and
 
94
<a href="../api_java/db_verify.html">Db.verify</a>.
 
95
</tt>
 
96
<table width="100%"><tr><td><br></td><td align=right>
 
97
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
98
</td></tr></table>
 
99
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
100
</body>
 
101
</html>