Lucene++ - a full-featured, c++ search engine
API Documentation
An interprocess mutex lock. More...
#include <Lock.h>
Public Member Functions | |
virtual | ~Lock () |
virtual String | getClassName () |
boost::shared_ptr< Lock > | shared_from_this () |
virtual bool | obtain ()=0 |
Attempts to obtain exclusive access and immediately return upon success or failure. More... | |
virtual void | release ()=0 |
Releases exclusive access. More... | |
virtual bool | isLocked ()=0 |
Returns true if the resource is currently locked. Note that one must still call obtain() before using the resource. More... | |
bool | obtain (int32_t lockWaitTimeout) |
Attempts to obtain an exclusive lock within amount of time given. Polls once per LOCK_POLL_INTERVAL (currently 1000) milliseconds until lockWaitTimeout is passed. More... | |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
virtual String | toString () |
Returns a string representation of the object. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
Static Public Attributes | |
static const int32_t | LOCK_OBTAIN_WAIT_FOREVER |
How long obtain(int64_t) waits, in milliseconds, in between attempts to acquire the lock. More... | |
static const int32_t | LOCK_POLL_INTERVAL |
Pass this value to obtain(int64_t) to try forever to obtain the lock. More... | |
Additional Inherited Members | |
![]() | |
LuceneObject () | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
An interprocess mutex lock.
|
virtual |
|
inlinestatic |
|
inlinevirtual |
|
pure virtual |
Returns true if the resource is currently locked. Note that one must still call obtain() before using the resource.
|
pure virtual |
Attempts to obtain exclusive access and immediately return upon success or failure.
bool Lucene::Lock::obtain | ( | int32_t | lockWaitTimeout | ) |
Attempts to obtain an exclusive lock within amount of time given. Polls once per LOCK_POLL_INTERVAL (currently 1000) milliseconds until lockWaitTimeout is passed.
lockWaitTimeout | length of time to wait in milliseconds or LOCK_OBTAIN_WAIT_FOREVER to retry forever. |
|
pure virtual |
Releases exclusive access.
|
inline |
|
static |
How long obtain(int64_t) waits, in milliseconds, in between attempts to acquire the lock.
|
static |
Pass this value to obtain(int64_t) to try forever to obtain the lock.