Zend_Search_Lucene_LockManager Class Reference

Static Public Member Functions
static	obtainWriteLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Obtain exclusive write lock on the index.
static	releaseWriteLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Release exclusive write lock.
static	obtainReadLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Obtain shared read lock on the index.
static	releaseReadLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Release shared read lock.
static	escalateReadLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Escalate Read lock to exclusive level.
static	deEscalateReadLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	De-escalate Read lock to shared level.
static	obtainOptimizationLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Obtain exclusive optimization lock on the index.
static	releaseOptimizationLock (Zend_Search_Lucene_Storage_Directory $lockDirectory)
	Release exclusive optimization lock.

Public Attributes
const	WRITE_LOCK_FILE = 'write.lock.file'
	consts for name of file to show lock status
const	READ_LOCK_FILE = 'read.lock.file'
const	READ_LOCK_PROCESSING_LOCK_FILE = 'read-lock-processing.lock.file'
const	OPTIMIZATION_LOCK_FILE = 'optimization.lock.file'

Member Function Documentation

static deEscalateReadLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

De-escalate Read lock to shared level.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

static escalateReadLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Escalate Read lock to exclusive level.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

Returns

boolean

static obtainOptimizationLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Obtain exclusive optimization lock on the index.

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

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

Returns

mixed

static obtainReadLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Obtain shared read lock on the index.

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

Parameters

Zend_Search_Lucene_Storage_Directory

$defaultLockDirectory

Returns

Zend_Search_Lucene_Storage_File

Exceptions

Zend_Search_Lucene_Exception

static obtainWriteLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Obtain exclusive write lock on the index.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

Returns

Zend_Search_Lucene_Storage_File

Exceptions

Zend_Search_Lucene_Exception

static releaseOptimizationLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Release exclusive optimization lock.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

static releaseReadLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Release shared read lock.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

static releaseWriteLock ( Zend_Search_Lucene_Storage_Directory  $lockDirectory )

static

Release exclusive write lock.

Parameters

Zend_Search_Lucene_Storage_Directory

$lockDirectory

Member Data Documentation

const OPTIMIZATION_LOCK_FILE = 'optimization.lock.file'

const READ_LOCK_FILE = 'read.lock.file'

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

const WRITE_LOCK_FILE = 'write.lock.file'

consts for name of file to show lock status