phpDocumentor GalleryCore
Classes
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: DatabaseLockSystem

Source Location: /modules/core/classes/DatabaseLockSystem.class

Class DatabaseLockSystem

Class Overview

Database backed locking. This is less efficient than filesystem based locking, but is more reliable and portable.

Located in /modules/core/classes/DatabaseLockSystem.class [line 39]

GalleryLockSystem
   |
   --DatabaseLockSystem

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryLockSystem

GalleryLockSystem::$_locks
GalleryLockSystem::$_releaseQueue

Inherited From GalleryLockSystem

GalleryLockSystem::GalleryLockSystem()
GalleryLockSystem::acquireReadLock()
Read lock one or more objects
GalleryLockSystem::acquireWriteLock()
Write lock one or more objects
GalleryLockSystem::getLockIds()
Return the ids of all the locks we hold
GalleryLockSystem::isReadLocked()
Return true if the given id is read locked or write locked
GalleryLockSystem::isWriteLocked()
Return true if the given id is write locked
GalleryLockSystem::refreshLocks()
Refresh all the locks that we hold so that they aren't accidentally considered expired
GalleryLockSystem::releaseAllLocks()
Release any locks that we're holding
GalleryLockSystem::releaseLocks()
Release the given lock(s) (queue the specified locks for later release on transactional databases or release them immediately if transactions are not supported)
GalleryLockSystem::releaseQueue()
Cleanup any locks queued for release
GalleryLockSystem::_acquireLock()
Extending class must implement this function to actually acquire a lock.
GalleryLockSystem::_moveObjectsBetweenLocks()
Move ids from givens locks into a new lock.
GalleryLockSystem::_newLockId()
Generate an id for a new lock.
GalleryLockSystem::_releaseLocksNow()
Release the given locks now
GalleryLockSystem::_removeObjectsFromLock()
Remove some object ids from the given lock.

[ Top ]
Method Summary
void   refreshLocks()  
void   _acquireLock()  
void   _moveObjectsBetweenLocks()  
void   _newLockId()  
void   _releaseLocksNow()  
void   _removeObjectsFromLock()  

[ Top ]
Methods
refreshLocks  [line 132]

  void refreshLocks( $freshUntil  )

Parameters:
   $freshUntil: 

API Tags:
See:  GalleryLockSystem::refreshLocks


Redefinition of:
GalleryLockSystem::refreshLocks()
Refresh all the locks that we hold so that they aren't accidentally considered expired

[ Top ]
_acquireLock  [line 44]

  void _acquireLock( $ids, $timeout, $lockType  )

Parameters:
   $ids: 
   $timeout: 
   $lockType: 

API Tags:
See:  GalleryLockSystem::_acquireLock


Redefinition of:
GalleryLockSystem::_acquireLock()
Extending class must implement this function to actually acquire a lock.

[ Top ]
_moveObjectsBetweenLocks  [line 99]

  void _moveObjectsBetweenLocks( $relock, $newLockId  )

Parameters:
   $relock: 
   $newLockId: 

API Tags:
See:  GalleryLockSystem:_moveObjectsBetweenLocks


Redefinition of:
GalleryLockSystem::_moveObjectsBetweenLocks()
Move ids from givens locks into a new lock.

[ Top ]
_newLockId  [line 118]

  void _newLockId( )


API Tags:
See:  GalleryLockSystem::_newLockId


Redefinition of:
GalleryLockSystem::_newLockId()
Generate an id for a new lock.

[ Top ]
_releaseLocksNow  [line 67]

  void _releaseLocksNow( $locks  )

Parameters:
   $locks: 

API Tags:
See:  GalleryLockSystem::_releaseLocksNow


Redefinition of:
GalleryLockSystem::_releaseLocksNow()
Release the given locks now

[ Top ]
_removeObjectsFromLock  [line 82]

  void _removeObjectsFromLock( &$lock, $ids  )

Parameters:
   &$lock: 
   $ids: 

API Tags:
See:  GalleryLockSystem:_removeObjectsFromLock


Redefinition of:
GalleryLockSystem::_removeObjectsFromLock()
Remove some object ids from the given lock.

[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:45:54 -0700 by phpDocumentor 1.3.0RC6