https://github.com/ronnylt/redlock-php

Redis distributed locks in PHP
https://github.com/ronnylt/redlock-php

distributed lock php redis

Last synced: 9 days ago
JSON representation

Redis distributed locks in PHP

• Host: GitHub
• URL: https://github.com/ronnylt/redlock-php
• Owner: ronnylt
• License: mit
• Created: 2014-05-17T08:36:05.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-08-11T17:36:09.000Z (about 4 years ago)
• Last Synced: 2024-04-13T17:53:13.260Z (7 months ago)
• Topics: distributed, lock, php, redis
• Language: PHP
• Homepage:
• Size: 5.86 KB
• Stars: 761
• Watchers: 25
• Forks: 253
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• favorite-link - Redis 在 PHP 中分布锁。

README

        
# RedLock – Redis distributed locks in PHP

Based on [Redlock-rb](https://github.com/antirez/redlock-rb) by [Salvatore Sanfilippo](https://github.com/antirez)

This library implements the Redis-based distributed lock manager algorithm [described in this blog post](http://antirez.com/news/77).

To create a lock manager:

```php

$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:

```php

$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:

```php

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:

```php

    $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.

The retry delay is actually chosen at random between `$retryDelay / 2` milliseconds and

the specified `$retryDelay` value.

**Disclaimer**: As stated in the original antirez's version, this code implements an algorithm

which is currently a proposal, it was not formally analyzed. Make sure to understand how it works

before using it in your production environments.