Classes List

Symfony\Component\Lock\LockInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Lock;

use Symfony\Component\Lock\Exception\LockAcquiringException;
use Symfony\Component\Lock\Exception\LockConflictedException;
use Symfony\Component\Lock\Exception\LockReleasingException;

/** * LockInterface defines an interface to manipulate the status of a lock. * * @author Jérémy Derussé <jeremy@derusse.com> */
interface LockInterface
{
    /** * Acquires the lock. If the lock is acquired by someone else, the parameter `blocking` determines whether or not * the the call should block until the release of the lock. * * @param bool $blocking Whether or not the Lock should wait for the release of someone else * * @return bool whether or not the lock had been acquired * * @throws LockConflictedException If the lock is acquired by someone else in blocking mode * @throws LockAcquiringException If the lock can not be acquired */
    public function acquire($blocking = false);

    /** * Increase the duration of an acquired lock. * * @throws LockConflictedException If the lock is acquired by someone else * @throws LockAcquiringException If the lock can not be refreshed */
    public function refresh();

    /** * Returns whether or not the lock is acquired. * * @return bool */
    public function isAcquired();

    /** * Release the lock. * * @throws LockReleasingException If the lock can not be released */
    public function release();
}