[Xapian-tickets] [Xapian] #3: Deprecate Xapian::ErrorHandler? (was: Test coverage for Xapian::ErrorHandler)

[Xapian]

#3: Deprecate Xapian::ErrorHandler?
-------------------------+--------------------------------------------------
 Reporter:  olly         |        Owner:  olly     
     Type:  enhancement  |       Status:  assigned 
 Priority:  lowest       |    Milestone:  1.3.0    
Component:  Library API  |      Version:  SVN trunk
 Severity:  minor        |   Resolution:           
 Keywords:               |    Blockedby:           
 Platform:  All          |     Blocking:           
-------------------------+--------------------------------------------------
Changes (by olly):

  * component:  Test Suite => Library API
  * milestone:  2.0.0 => 1.3.0


Comment:

 As we've discussed a couple of times on IRC in the past few months,
 {{{Xapian::ErrorHandler}}} was originally added as a fairly quick hack to
 allow webtop to
 handle a server not responding - it meant they could complete searches
 despite this, and
 log the lack of a response.

 The documentation isn't really that great for it, but despite this I can't
 remember any
 user questions about it, or find any in my IRC logs or the mailing list
 archives.  I also
 can't find any uses of it in Google's codesearch.

 Thinking about the problem it is trying to address, I think !ErrorHandler
 shouldn't be an
 Enquire-related feature - errors from working with a database outside of
 Enquire are
 interesting too.

 There are related issues about which sub-database we're talking about in
 error messages,
 such as #329.  Perhaps you should be able to specify a string "name" for a
 Database
 object which is just an opaque token to Xapian, to be reported in
 exceptions (and so
 available to !ErrorHandler) - the Error class already has a "context"
 which we only use
 for remote databases I think.  The name could default to something
 plausible, such as the
 pathname for disk-based databases.

 Anyway, my proposal is to deprecate !ErrorHandler and related API features
 in 1.3.0, and
 think further about a replacement, ideally to be added in 1.3.x.

-- 
Ticket URL: <http://trac.xapian.org/ticket/3#comment:8>
Xapian <http://xapian.org/>
Xapian