Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes
Lucene::CheckAbort Class Reference

#include <SegmentMerger.h>

+ Inheritance diagram for Lucene::CheckAbort:

Public Member Functions

 CheckAbort (const OneMergePtr &merge, const DirectoryPtr &dir)
 
virtual ~CheckAbort ()
 
virtual String getClassName ()
 
boost::shared_ptr< CheckAbortshared_from_this ()
 
virtual void work (double units)
 Records the fact that roughly units amount of work have been done since this method was last called. When adding time-consuming code into SegmentMerger, you should test different values for units to ensure that the time in between calls to merge.checkAborted is up to ~ 1 second.
 
- Public Member Functions inherited from Lucene::LuceneObject
virtual ~LuceneObject ()
 
virtual void initialize ()
 Called directly after instantiation to create objects that depend on this object being fully constructed.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Return clone of this object.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
virtual String toString ()
 Returns a string representation of the object.
 
- Public Member Functions inherited from Lucene::LuceneSync
virtual ~LuceneSync ()
 
virtual SynchronizePtr getSync ()
 Return this object synchronize lock.
 
virtual LuceneSignalPtr getSignal ()
 Return this object signal.
 
virtual void lock (int32_t timeout=0)
 Lock this object using an optional timeout.
 
virtual void unlock ()
 Unlock this object.
 
virtual bool holdsLock ()
 Returns true if this object is currently locked by current thread.
 
virtual void wait (int32_t timeout=0)
 Wait for signal using an optional timeout.
 
virtual void notifyAll ()
 Notify all threads waiting for signal.
 

Static Public Member Functions

static String _getClassName ()
 

Protected Attributes

double workCount
 
OneMergePtr merge
 
DirectoryWeakPtr _dir
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Constructor & Destructor Documentation

◆ CheckAbort()

Lucene::CheckAbort::CheckAbort ( const OneMergePtr merge,
const DirectoryPtr dir 
)

◆ ~CheckAbort()

virtual Lucene::CheckAbort::~CheckAbort ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::CheckAbort::_getClassName ( )
inlinestatic

◆ getClassName()

virtual String Lucene::CheckAbort::getClassName ( )
inlinevirtual

Reimplemented in Lucene::CheckAbortNull.

◆ shared_from_this()

boost::shared_ptr< CheckAbort > Lucene::CheckAbort::shared_from_this ( )
inline

◆ work()

virtual void Lucene::CheckAbort::work ( double  units)
virtual

Records the fact that roughly units amount of work have been done since this method was last called. When adding time-consuming code into SegmentMerger, you should test different values for units to ensure that the time in between calls to merge.checkAborted is up to ~ 1 second.

Reimplemented in Lucene::CheckAbortNull.

Field Documentation

◆ _dir

DirectoryWeakPtr Lucene::CheckAbort::_dir
protected

◆ merge

OneMergePtr Lucene::CheckAbort::merge
protected

◆ workCount

double Lucene::CheckAbort::workCount
protected

The documentation for this class was generated from the following file:

clucene.sourceforge.net