<?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 NotSupportedException
public function waitAndSave(Key $key);
* Extends the ttl of a resource.
* @param float $ttl amount of second to keep the lock in the store
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);
}