dakota/redlock-php

Redis distributed locks in PHP

v1.1.0 2018-04-04 13:53 UTC

Requires

• php: >=5.4.0
• colinmollenhour/credis: ^1.7

Suggests

• ext-redis: Native PHP extension for Redis connectivity. Credis will automatically utilize when available.

MIT

• Walther Lalk
• Ronny Lopez
• Keith Palmer

README

redlock-php - Redis distributed locks in PHP

• Forked from redlock-php by Ronny Lopez
• Based on Redlock-rb by Salvatore Sanfilippo

This library implements the Redis-based distributed lock manager algorithm described on the Redis website.

It relies on Credis for Redis connections. Credis offers a native pure-PHP implementation which will automatically switch to using phpredis for improved performance if it's available.

To create a lock manager:

$servers = [
    ['127.0.0.1', 6379, 0.01],
    ['127.0.0.1', 6389, 0.01],
    ['127.0.0.1', 6399, 0.01],
];

$redLock = new RedLock($servers);

To acquire a lock:

$lock = $redLock->lock('my_resource_name', 1000);

Where the resource name is an unique identifier of what you are trying to lock and 1000 is the number of milliseconds for the validity time.

The returned value is false if the lock was not acquired (you may try again), otherwise an array representing the lock is returned, having three keys:

Array
(
    [validity] => 9897.3020019531
    [resource] => my_resource_name
    [token] => 53771bfa1e775
)

• validity, an integer representing the number of milliseconds the lock will be valid.
• resource, the name of the locked resource as specified by the user.
• token, a random token value which is used to safe reclaim the lock.

To release a lock:

    $redLock->unlock($lock)

It is possible to setup the number of retries (by default 3) and the retry delay (by default 200 milliseconds) used to acquire the lock.