Search/Lucene/LockManager.php
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Version
- $Id: LockManager.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_LockManager
Package: Zend\Search\LuceneThis is an utility class which provides index locks processing functionality
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants


WRITE_LOCK_FILE
= 'write.lock.file'
consts for name of file to show lock status


READ_LOCK_FILE
= 'read.lock.file'


READ_LOCK_PROCESSING_LOCK_FILE
= 'read-lock-processing.lock.file'


OPTIMIZATION_LOCK_FILE
= 'optimization.lock.file'
Methods



_startReadLockProcessing(\Zend_Search_Lucene_Storage_Directory $lockDirectory) : \Zend_Search_Lucene_Storage_File
staticObtain the exclusive "read escalation/de-escalation" lock
Required to protect the escalate/de-escalate read lock process
on GFS (and potentially other) mounted filesystems.
Why we need this:
While GFS supports cluster-wide locking via flock(), it's
implementation isn't quite what it should be. The locking
semantics that work consistently on a local filesystem tend to
fail on GFS mounted filesystems. This appears to be a design defect
in the implementation of GFS. How this manifests itself is that
conditional promotion of a shared lock to exclusive will always
fail, lock release requests are honored but not immediately
processed (causing erratic failures of subsequent conditional
requests) and the releasing of the exclusive lock before the
shared lock is set when a lock is demoted (which can open a window
of opportunity for another process to gain an exclusive lock when
it shoudln't be allowed to).
ParametersReturnsThrows


_stopReadLockProcessing(\Zend_Search_Lucene_Storage_Directory $lockDirectory) : void
staticRelease the exclusive "read escalation/de-escalation" lock
Required to protect the escalate/de-escalate read lock process
on GFS (and potentially other) mounted filesystems.
Parameters


obtainOptimizationLock(\Zend_Search_Lucene_Storage_Directory $lockDirectory) : mixed
staticObtain exclusive optimization lock on the index
Returns lock object on success and false otherwise (doesn't block execution)
ParametersReturns


obtainReadLock( $lockDirectory) : \Zend_Search_Lucene_Storage_File
staticObtain shared read lock on the index
It doesn't block other read or update processes, but prevent index from the premature cleaning-up
ParametersName | Type | Description |
---|
$lockDirectory | | |
---|
ReturnsThrows