wujingke/lock

Lock component for hyperf.

Lock

Lock component for hyperf. 中文说明

Installation

• Request

composer require "friendsofhyperf/lock"

• Publish

php bin/hyperf.php vendor:publish friendsofhyperf/lock

Usage

You may create and manage locks using the LockFactory::make() method:

use FriendsOfHyperf\Lock\LockFactory;

$lock = LockFactory::make($name = 'foo', $seconds = 10, $owner = null);

if ($lock->get()) {
    // Lock acquired for 10 seconds...

    $lock->release();
}

The get method also accepts a closure. After the closure is executed, Will automatically release the lock:

LockFactory::make('foo')->get(function () {
    // Lock acquired indefinitely and automatically released...
});

If the lock is not available at the moment you request it, you may instruct the lock to wait for a specified number of seconds. If the lock can not be acquired within the specified time limit, an FriendsOfHyperf\Lock\Exception\LockTimeoutException will be thrown:

use FriendsOfHyperf\Lock\Exception\LockTimeoutException;
use FriendsOfHyperf\Lock\LockFactory;

$lock = LockFactory::make('foo', 10);

try {
    $lock->block(5);

    // Lock acquired after waiting maximum of 5 seconds...
} catch (LockTimeoutException $e) {
    // Unable to acquire lock...
} finally {
    optional($lock)->release();
}

LockFactory::make('foo', 10)->block(5, function () {
    // Lock acquired after waiting maximum of 5 seconds...
});