Search/Lucene/LockManager.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
version: $Id: LockManager.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Search_Lucene_LockManager

Description

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.

Zend_Search_Lucene_LockManager
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Search_Lucene
Constants: WRITE_LOCK_FILE; READ_LOCK_FILE; READ_LOCK_PROCESSING_LOCK_FILE; OPTIMIZATION_LOCK_FILE
Methods: obtainWriteLock; releaseWriteLock; _startReadLockProcessing; _stopReadLockProcessing; obtainReadLock; releaseReadLock; escalateReadLock; deEscalateReadLock; obtainOptimizationLock; releaseOptimizationLock

Description

This is an utility class which provides index locks processing functionality

Constants

WRITE_LOCK_FILE
jump to class

 WRITE_LOCK_FILE = 'write.lock.file'

consts for name of file to show lock status

Details

value: write.lock.file

READ_LOCK_FILE
jump to class

 READ_LOCK_FILE = 'read.lock.file'

Details

value: read.lock.file

READ_LOCK_PROCESSING_LOCK_FILE
jump to class

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

Details

value: read-lock-processing.lock.file

OPTIMIZATION_LOCK_FILE
jump to class

 OPTIMIZATION_LOCK_FILE = 'optimization.lock.file'

Details

value: optimization.lock.file

Methods

_startReadLockProcessing
jump to class

_startReadLockProcessing(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :
        Zend_Search_Lucene_Storage_File

Obtain 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).

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Output

Zend_Search_Lucene_Storage_File

Details

visibility: private
final: false
static: true
throws

_stopReadLockProcessing
jump to class

_stopReadLockProcessing(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :

Release the exclusive "read escalation/de-escalation" lock

Required to protect the escalate/de-escalate read lock process on GFS (and potentially other) mounted filesystems.

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Details

visibility: private
final: false
static: true

deEscalateReadLock
jump to class

deEscalateReadLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :

De-escalate Read lock to shared level

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Details

visibility: public
final: false
static: true

escalateReadLock
jump to class

escalateReadLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :
        boolean

Escalate Read lock to exclusive level

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Output

boolean

Details

visibility: public
final: false
static: true

obtainOptimizationLock
jump to class

obtainOptimizationLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :
        mixed

Obtain exclusive optimization lock on the index

Returns lock object on success and false otherwise (doesn't block execution)

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Output

mixed

Details

visibility: public
final: false
static: true

obtainReadLock
jump to class

obtainReadLock(
           $lockDirectory
          )
        
        :
        Zend_Search_Lucene_Storage_File

Obtain shared read lock on the index

It doesn't block other read or update processes, but prevent index from the premature cleaning-up

Arguments

$lockDirectory

Output

Zend_Search_Lucene_Storage_File

Details

visibility: public
final: false
static: true
throws

obtainWriteLock
jump to class

obtainWriteLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :
        Zend_Search_Lucene_Storage_File

Obtain exclusive write lock on the index

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Output

Zend_Search_Lucene_Storage_File

Details

visibility: public
final: false
static: true
throws

releaseOptimizationLock
jump to class

releaseOptimizationLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :

Release exclusive optimization lock

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Details

visibility: public
final: false
static: true

releaseReadLock
jump to class

releaseReadLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :

Release shared read lock

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Details

visibility: public
final: false
static: true

releaseWriteLock
jump to class

releaseWriteLock(
          Zend_Search_Lucene_Storage_Directory $lockDirectory
          )
        
        :

Release exclusive write lock

Arguments

$lockDirectory: Zend_Search_Lucene_Storage_Directory

Details

visibility: public
final: false
static: true

API Documentation

Search/Lucene/LockManager.php

Description

Zend_Search_Lucene_LockManagerjump to top

Description

Constants

WRITE_LOCK_FILEjump to class

Details

READ_LOCK_FILEjump to class

Details

READ_LOCK_PROCESSING_LOCK_FILEjump to class

Details

OPTIMIZATION_LOCK_FILEjump to class

Details

Methods

_startReadLockProcessingjump to class

Arguments

Output

Details

_stopReadLockProcessingjump to class

Arguments

Details

deEscalateReadLockjump to class

Arguments

Details

escalateReadLockjump to class

Arguments

Output

Details

obtainOptimizationLockjump to class

Arguments

Output

Details

obtainReadLockjump to class

Arguments

Output

Details

obtainWriteLockjump to class

Arguments

Output

Details

releaseOptimizationLockjump to class

Arguments

Details

releaseReadLockjump to class

Arguments

Details

releaseWriteLockjump to class

Arguments

Details

Zend_Search_Lucene_LockManager
jump to top

WRITE_LOCK_FILE
jump to class

READ_LOCK_FILE
jump to class

READ_LOCK_PROCESSING_LOCK_FILE
jump to class

OPTIMIZATION_LOCK_FILE
jump to class

_startReadLockProcessing
jump to class

_stopReadLockProcessing
jump to class

deEscalateReadLock
jump to class

escalateReadLock
jump to class

obtainOptimizationLock
jump to class

obtainReadLock
jump to class

obtainWriteLock
jump to class

releaseOptimizationLock
jump to class

releaseReadLock
jump to class

releaseWriteLock
jump to class