Daniel Guzman
39 lines
1.2 KiB
PHP
39 lines
1.2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Doctrine\ORM\Cache;
|
|
|
|
/**
|
|
* Defines contract for concurrently managed data region.
|
|
* It should be able to lock an specific cache entry in an atomic operation.
|
|
*
|
|
* When a entry is locked another process should not be able to read or write the entry.
|
|
* All evict operation should not consider locks, even though an entry is locked evict should be able to delete the entry and its lock.
|
|
*/
|
|
interface ConcurrentRegion extends Region
|
|
{
|
|
/**
|
|
* Attempts to read lock the mapping for the given key.
|
|
*
|
|
* @param CacheKey $key The key of the item to lock.
|
|
*
|
|
* @return Lock|null A lock instance or NULL if the lock already exists.
|
|
*
|
|
* @throws LockException Indicates a problem accessing the region.
|
|
*/
|
|
public function lock(CacheKey $key);
|
|
|
|
/**
|
|
* Attempts to read unlock the mapping for the given key.
|
|
*
|
|
* @param CacheKey $key The key of the item to unlock.
|
|
* @param Lock $lock The lock previously obtained from {@link readLock}
|
|
*
|
|
* @return bool
|
|
*
|
|
* @throws LockException Indicates a problem accessing the region.
|
|
*/
|
|
public function unlock(CacheKey $key, Lock $lock);
|
|
}
|