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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:46 EDT 2010 -->
<TITLE>
EventHandler (Oracle - Berkeley DB Java API)
</TITLE>
<META NAME="date" CONTENT="2010-04-12">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EventHandler (Oracle - Berkeley DB Java API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EventHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/EventHandlerAdapter.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/EventHandler.html" target="_top"><B>FRAMES</B></A>
<A HREF="EventHandler.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.db</FONT>
<BR>
Interface EventHandler</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/sleepycat/db/EventHandlerAdapter.html" title="class in com.sleepycat.db">EventHandlerAdapter</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>EventHandler</B></DL>
</PRE>
<P>
An interface classs with prototype definitions of all event functions that
can be called via the Berkeley DB event callback mechanism.
<p>
A user can choose to implement the EventHandler class, and implement handlers
for all of the event types. Alternatively it is possible to extend the
EventHandlerAdapter class, and implement only those events relevant to the
specific application.
<p>
The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setEventHandler(com.sleepycat.db.EventHandler)"><CODE>EnvironmentConfig.setEventHandler</CODE></A> is used to provide
a mechanism for reporting event messages from the Berkeley DB library
to the application.
<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>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handlePanicEvent()">handlePanicEvent</A></B>()</CODE>
<BR>
A callback function to be called when a panic event is sent from the Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepClientEvent()">handleRepClientEvent</A></B>()</CODE>
<BR>
A callback function to be called when a Replication Client event is sent
from the Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepElectedEvent()">handleRepElectedEvent</A></B>()</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepMasterEvent()">handleRepMasterEvent</A></B>()</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepNewMasterEvent(int)">handleRepNewMasterEvent</A></B>(int envId)</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepPermFailedEvent()">handleRepPermFailedEvent</A></B>()</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepStartupDoneEvent()">handleRepStartupDoneEvent</A></B>()</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EventHandler.html#handleWriteFailedEvent(int)">handleWriteFailedEvent</A></B>(int errorCode)</CODE>
<BR>
A callback function to be called when an event is sent from the
Berkeley DB library.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="handlePanicEvent()"><!-- --></A><H3>
handlePanicEvent</H3>
<PRE>
void <B>handlePanicEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when a panic event is sent from the Berkeley DB library.
<p> This event callback is received when an error occurs in the Berkeley DB
library where the only solution is to shut down the application and run
recovery. In such cases, the Berkeley DB methods will throw
<A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A> exceptions. It is often easier to simply exit
the application when such errors occur, rather than gracefully return up
the stack.
<p>
When this callback is received the database environment has failed. All
threads of control in the database environment should exit the environment
and recovery should be run.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepClientEvent()"><!-- --></A><H3>
handleRepClientEvent</H3>
<PRE>
void <B>handleRepClientEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when a Replication Client event is sent
from the Berkeley DB library.
<p>
This event callback is received when this member of a replication group is
now a client site.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepElectedEvent()"><!-- --></A><H3>
handleRepElectedEvent</H3>
<PRE>
void <B>handleRepElectedEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when this site has just won an election. An
Application using the Base replication API should arrange for a call to
the <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication</CODE></A> method after receiving this
event to, reconfigure the local environment as a replication master.
<p>
Replication Manager applications may safely igore this event. The
Replication Manager calls <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication</CODE></A>
automatically on behalf of the application when appropriate (resulting in
firing of the <A HREF="../../../com/sleepycat/db/EventHandler.html#handleRepMasterEvent()"><CODE>EventHandler.handleRepMasterEvent</CODE></A> event).
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepMasterEvent()"><!-- --></A><H3>
handleRepMasterEvent</H3>
<PRE>
void <B>handleRepMasterEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when this site is now the master site of
its replication group. It is the application's responsibility to begin
acting as the master environment.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepNewMasterEvent(int)"><!-- --></A><H3>
handleRepNewMasterEvent</H3>
<PRE>
void <B>handleRepNewMasterEvent</B>(int envId)</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when the replication group of which this
site is a member has just established a new master; the local site is not
the new master.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>envId</CODE> - The environment ID of the new master site.</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepPermFailedEvent()"><!-- --></A><H3>
handleRepPermFailedEvent</H3>
<PRE>
void <B>handleRepPermFailedEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when the replication manager did not
receive enough acknowledgements (based on the acknowledgement policy
configured with <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationManagerAckPolicy(com.sleepycat.db.ReplicationManagerAckPolicy)"><CODE>EnvironmentConfig.setReplicationManagerAckPolicy</CODE></A>)
to ensure a transaction's durability within the replication group. The
transaction will be flushed to the master's local disk storage for
durability.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleRepStartupDoneEvent()"><!-- --></A><H3>
handleRepStartupDoneEvent</H3>
<PRE>
void <B>handleRepStartupDoneEvent</B>()</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when the client has completed startup
synchronization and is now processing live log records received from the
master.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="handleWriteFailedEvent(int)"><!-- --></A><H3>
handleWriteFailedEvent</H3>
<PRE>
void <B>handleWriteFailedEvent</B>(int errorCode)</PRE>
<DL>
<DD>A callback function to be called when an event is sent from the
Berkeley DB library.
<p>
This event callback is received when a Berkeley DB write to stable storage
failed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>errorCode</CODE> - If an operating system specific error code is available for the failure it
will be passed in the errorCode parameter.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/EventHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/EventHandlerAdapter.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/EventHandler.html" target="_top"><B>FRAMES</B></A>
<A HREF="EventHandler.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font>
</BODY>
</HTML>
|
