class RedisStore implements StoreInterface

RedisStore is a StoreInterface implementation using Redis as store engine.

Methods

__construct(Redis|RedisArray|RedisCluster|Client $redisClient, float $initialTtl = 300.0)

No description

save(Key $key)

Stores the resource if it's not locked by someone else.

waitAndSave(Key $key)

Waits until a key becomes free, then stores the resource.

putOffExpiration(Key $key, $ttl)

Extends the ttl of a resource.

delete(Key $key)

Removes a resource from the storage.

bool
exists(Key $key)

Returns whether or not the resource exists in the storage.

Details

at line 35
__construct(Redis|RedisArray|RedisCluster|Client $redisClient, float $initialTtl = 300.0)

Parameters

Redis|RedisArray|RedisCluster|Client $redisClient
float $initialTtl the expiration delay of locks in seconds

at line 52
save(Key $key)

Stores the resource if it's not locked by someone else.

Parameters

Key $key

Exceptions

LockConflictedException

at line 74
waitAndSave(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.

at line 82
putOffExpiration(Key $key, $ttl)

Extends the ttl of a resource.

If the store does not support this feature it should throw a NotSupportedException.

Parameters

Key $key
$ttl

Exceptions

LockConflictedException
NotSupportedException

at line 105
delete(Key $key)

Removes a resource from the storage.

Parameters

Key $key

at line 121
bool exists(Key $key)

Returns whether or not the resource exists in the storage.

Parameters

Key $key

Return Value

bool