Classes List

Symfony\Component\Lock\StoreInterface

 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 
 61 
 62 
 63 
 64 
 65 
<?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\LockConflictedException;
use Symfony\Component\Lock\Exception\NotSupportedException;

/** * StoreInterface defines an interface to manipulate a lock store. * * @author Jérémy Derussé <jeremy@derusse.com> */
interface StoreInterface
{
    /** * Stores the resource if it's not locked by someone else. * * @throws LockConflictedException */
    public function save(Key $key);

    /** * Waits until a key becomes free, then stores the resource. * * If the store does not support this feature it should throw a NotSupportedException. * * @throws LockConflictedException * @throws NotSupportedException */
    public function waitAndSave(Key $key);

    /** * Extends the ttl of a resource. * * If the store does not support this feature it should throw a NotSupportedException. * * @param float $ttl amount of second to keep the lock in the store * * @throws LockConflictedException * @throws NotSupportedException */
    public function putOffExpiration(Key $key$ttl);

    /** * Removes a resource from the storage. */
    public function delete(Key $key);

    /** * Returns whether or not the resource exists in the storage. * * @return bool */
    public function exists(Key $key);
}