interface SharedLockInterface

SharedLockInterface defines an interface to manipulate the status of a shared lock.

@author Jérémy Derussé <jeremy@derusse.com>

Hierarchy

interface \Symfony\Component\Lock\LockInterface
- interface \Symfony\Component\Lock\SharedLockInterface extends \Symfony\Component\Lock\LockInterface

Expanded class hierarchy of SharedLockInterface

All classes that implement SharedLockInterface

File

vendor/symfony/lock/SharedLockInterface.php, line 22

Namespace

Symfony\Component\Lock

View source

interface SharedLockInterface extends LockInterface {
    
    /**
     * Acquires the lock for reading. If the lock is acquired by someone else in write mode, the parameter `blocking`
     * determines whether or not the call should block until the release of the lock.
     *
     * @throws LockConflictedException If the lock is acquired by someone else in blocking mode
     * @throws LockAcquiringException  If the lock cannot be acquired
     */
    public function acquireRead(bool $blocking = false) : bool;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
LockInterface::acquire	public	function	Acquires the lock. If the lock is acquired by someone else, the parameter `blocking` determines whether or not the call should block until the release of the lock.	2
LockInterface::getRemainingLifetime	public	function	Returns the remaining lifetime in seconds.	2
LockInterface::isAcquired	public	function	Returns whether or not the lock is acquired.	2
LockInterface::isExpired	public	function		2
LockInterface::refresh	public	function	Increase the duration of an acquired lock.	2
LockInterface::release	public	function	Release the lock.	2
SharedLockInterface::acquireRead	public	function	Acquires the lock for reading. If the lock is acquired by someone else in write mode, the parameter `blocking` determines whether or not the call should block until the release of the lock.	2