Skip to content

Repository files navigation

Lock

Latest Stable VersionTotal DownloadsLicense

The lock component for Hyperf. 中文说明

Installation

  • Require
composer require friendsofhyperf/lock
  • Publish
php bin/hyperf.php vendor:publish friendsofhyperf/lock -i config

Usage

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

$lock = lock($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:

lock('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:

useFriendsOfHyperf\Lock\Exception\LockTimeoutException;
$lock = lock('foo', 10);
try {
$lock->block(5);
// Lock acquired after waiting maximum of 5 seconds...
} catch (LockTimeoutException$e) {
// Unable to acquire lock...
} finally {
$lock->release();
}
lock('foo', 10)->block(5, function () {
// Lock acquired after waiting maximum of 5 seconds...
});

Using by annotation

useFriendsOfHyperf\Lock\Annotation\Lock;
useFriendsOfHyperf\Lock\Driver\LockInterface;
class Foo
{
#[Lock(name:"foo", seconds:10)]
protectedLockInterface$lock;
publicfunctionbar()
{
$this->lock->get(function () {
// Lock acquired indefinitely and automatically released...
});
}
}

Contact

License

MIT

About

[READ-ONLY]The lock component for Hyperf.

Resources

Security policy

Stars

14 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages