/usr/include/xapian/errorhandler.h is in libxapian-dev 1.4.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /** @file errorhandler.h
* @brief Decide if a Xapian::Error exception should be ignored.
*/
/* Copyright (C) 2003,2006,2007,2012,2013,2014,2016 Olly Betts
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef XAPIAN_INCLUDED_ERRORHANDLER_H
#define XAPIAN_INCLUDED_ERRORHANDLER_H
#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error "Never use <xapian/errorhandler.h> directly; include <xapian.h> instead."
#endif
#include <xapian/attributes.h>
#include <xapian/deprecated.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/visibility.h>
namespace Xapian {
class Error;
/** Decide if a Xapian::Error exception should be ignored.
*
* You can create your own subclass of this class and pass in an instance
* of it when you construct a Xapian::Enquire object. Xapian::Error
* exceptions which happen during the match process are passed to this
* object and it can decide whether they should propagate or whether
* Enquire should attempt to continue.
*
* 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).
*/
class XAPIAN_VISIBILITY_DEFAULT ErrorHandler
: public Xapian::Internal::opt_intrusive_base {
/// Don't allow assignment.
void operator=(const ErrorHandler &);
/// Don't allow copying.
ErrorHandler(const Xapian::ErrorHandler &);
/** Perform user-specified error handling.
*
* This virtual method must be defined by the API user to specify
* how a Xapian::Error is to be handled.
*
* If you want execution to continue (where possible), then return
* true. If you want the Error to be rethrown and propagate out
* of the library, then return false.
*
* Note that it's not always possible to continue execution, so
* the error may be rethrown even if you return true. The ErrorHandler
* is still called in this situation as you may want to log that a
* particular remote backend server isn't responding, and perhaps
* remove it from those being searched temporarily.
*
* @param error The Xapian::Error object under consideration.
*
* @return true to attempt to continue; false to rethrow the error.
*/
XAPIAN_DEPRECATED_EX(virtual bool handle_error(Xapian::Error &error)) = 0;
public:
/// Default constructor.
XAPIAN_NOTHROW(ErrorHandler()) {}
/// We require a virtual destructor because we have virtual methods.
virtual ~ErrorHandler();
/** Handle a Xapian::Error object.
*
* This method is called when a Xapian::Error object is thrown and
* caught inside Enquire. If this is the first ErrorHandler that
* the Error has been passed to, then the handle_error() virtual
* method is called, which allows the API user to decide how to
* handle the error.
*
* @param error The Xapian::Error object under consideration.
*/
void operator()(Xapian::Error &error);
/** Start reference counting this object.
*
* You can hand ownership of a dynamically allocated ErrorHandler
* object to Xapian by calling release() and then passing the object to a
* Xapian method. Xapian will arrange to delete the object once it is no
* longer required.
*/
ErrorHandler * release() {
opt_intrusive_base::release();
return this;
}
/** Start reference counting this object.
*
* You can hand ownership of a dynamically allocated ErrorHandler
* object to Xapian by calling release() and then passing the object to a
* Xapian method. Xapian will arrange to delete the object once it is no
* longer required.
*/
const ErrorHandler * release() const {
opt_intrusive_base::release();
return this;
}
};
}
#endif /* XAPIAN_INCLUDED_ERRORHANDLER_H */
|