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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::ErrorHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1ErrorHandler-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::ErrorHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Decide if a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exception should be ignored.
<a href="classXapian_1_1ErrorHandler.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::ErrorHandler:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1ErrorHandler__inherit__graph.png" border="0" usemap="#aXapian_1_1ErrorHandler_inherit__map" alt="Inheritance graph"/></div>
<map name="aXapian_1_1ErrorHandler_inherit__map" id="aXapian_1_1ErrorHandler_inherit__map">
<area shape="rect" title="Decide if a Xapian::Error exception should be ignored." alt="" coords="5,95,163,121"/>
<area shape="rect" title=" " alt="" coords="7,5,161,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2833c2fd77c9979574c63cee8db96e05"><td class="memItemLeft" align="right" valign="top"><a id="a2833c2fd77c9979574c63cee8db96e05"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html#a2833c2fd77c9979574c63cee8db96e05">ErrorHandler</a> ()</td></tr>
<tr class="memdesc:a2833c2fd77c9979574c63cee8db96e05"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a2833c2fd77c9979574c63cee8db96e05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4fccfeed11d85364088e5bed7f9048b"><td class="memItemLeft" align="right" valign="top"><a id="af4fccfeed11d85364088e5bed7f9048b"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html#af4fccfeed11d85364088e5bed7f9048b">~ErrorHandler</a> ()</td></tr>
<tr class="memdesc:af4fccfeed11d85364088e5bed7f9048b"><td class="mdescLeft"> </td><td class="mdescRight">We require a virtual destructor because we have virtual methods. <br /></td></tr>
<tr class="separator:af4fccfeed11d85364088e5bed7f9048b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3085bcf9a4e25bd2dd5d99710763b51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html#aa3085bcf9a4e25bd2dd5d99710763b51">operator()</a> (<a class="el" href="classXapian_1_1Error.html">Xapian::Error</a> &error)</td></tr>
<tr class="memdesc:aa3085bcf9a4e25bd2dd5d99710763b51"><td class="mdescLeft"> </td><td class="mdescRight">Handle a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> object. <a href="classXapian_1_1ErrorHandler.html#aa3085bcf9a4e25bd2dd5d99710763b51">More...</a><br /></td></tr>
<tr class="separator:aa3085bcf9a4e25bd2dd5d99710763b51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4b0e0bc0b1878669fb5d98f262d1591"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html#af4b0e0bc0b1878669fb5d98f262d1591">release</a> ()</td></tr>
<tr class="memdesc:af4b0e0bc0b1878669fb5d98f262d1591"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1ErrorHandler.html#af4b0e0bc0b1878669fb5d98f262d1591">More...</a><br /></td></tr>
<tr class="separator:af4b0e0bc0b1878669fb5d98f262d1591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2e100bf88203def1972f2f591e16436"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1ErrorHandler.html#ad2e100bf88203def1972f2f591e16436">release</a> () const</td></tr>
<tr class="memdesc:ad2e100bf88203def1972f2f591e16436"><td class="mdescLeft"> </td><td class="mdescRight">Start reference counting this object. <a href="classXapian_1_1ErrorHandler.html#ad2e100bf88203def1972f2f591e16436">More...</a><br /></td></tr>
<tr class="separator:ad2e100bf88203def1972f2f591e16436"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Decide if a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exception should be ignored. </p>
<p>You can create your own subclass of this class and pass in an instance of it when you construct a <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Xapian::Enquire</a> object. <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> exceptions which happen during the match process are passed to this object and it can decide whether they should propagate or whether <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Enquire</a> should attempt to continue.</p>
<p>The motivation is to allow searching over remote databases to handle a remote server which has died (both to allow results to be returned, and also so that such errors can be logged and dead servers temporarily removed from use). </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa3085bcf9a4e25bd2dd5d99710763b51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3085bcf9a4e25bd2dd5d99710763b51">◆ </a></span>operator()()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::ErrorHandler::operator() </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXapian_1_1Error.html">Xapian::Error</a> & </td>
<td class="paramname"><em>error</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> object. </p>
<p>This method is called when a <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> object is thrown and caught inside <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching.">Enquire</a>. If this is the first <a class="el" href="classXapian_1_1ErrorHandler.html" title="Decide if a Xapian::Error exception should be ignored.">ErrorHandler</a> that the <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Error</a> has been passed to, then the handle_error() virtual method is called, which allows the API user to decide how to handle the error.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>The <a class="el" href="classXapian_1_1Error.html" title="All exceptions thrown by Xapian are subclasses of Xapian::Error.">Xapian::Error</a> object under consideration. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af4b0e0bc0b1878669fb5d98f262d1591"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4b0e0bc0b1878669fb5d98f262d1591">◆ </a></span>release() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a>* Xapian::ErrorHandler::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start reference counting this object. </p>
<p>You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1ErrorHandler.html" title="Decide if a Xapian::Error exception should be ignored.">ErrorHandler</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1ErrorHandler.html#af4b0e0bc0b1878669fb5d98f262d1591" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </p>
</div>
</div>
<a id="ad2e100bf88203def1972f2f591e16436"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2e100bf88203def1972f2f591e16436">◆ </a></span>release() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXapian_1_1ErrorHandler.html">ErrorHandler</a>* Xapian::ErrorHandler::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start reference counting this object. </p>
<p>You can hand ownership of a dynamically allocated <a class="el" href="classXapian_1_1ErrorHandler.html" title="Decide if a Xapian::Error exception should be ignored.">ErrorHandler</a> object to <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> by calling <a class="el" href="classXapian_1_1ErrorHandler.html#af4b0e0bc0b1878669fb5d98f262d1591" title="Start reference counting this object.">release()</a> and then passing the object to a <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> method. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> will arrange to delete the object once it is no longer required. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="errorhandler_8h.html">errorhandler.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.1</a>
</small></address>
</body>
</html>
|
