Download the PHP package utopia-php/lock without Composer
On this page you can find all versions of the php package utopia-php/lock. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download utopia-php/lock
More information about utopia-php/lock
Files in utopia-php/lock
Package lock
Short Description A simple lock library to coordinate access to shared resources across coroutines, processes and hosts
License MIT
Informations about the package lock
Utopia Lock
[!IMPORTANT] This repository is a read-only mirror of
packages/lockin appwrite/appwrite. Development happens there — please open issues and pull requests against appwrite/appwrite.
Utopia Lock library is a simple and lite library for coordinating access to shared resources in PHP applications. This library provides a single interface backed by four lock primitives — mutex, semaphore, file and distributed — for serialising work across coroutines, processes, hosts and clusters. This library is maintained by the Appwrite team.
Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.
Getting started
Install using Composer:
System requirements
Utopia Lock requires PHP 8.3 or later. We recommend using the latest PHP version whenever possible.
The Mutex and Semaphore primitives require the Swoole extension (>=6.0). The Distributed primitive requires the Redis extension.
Features
Supported primitives
| Primitive | Scope | Backing | Use when |
|---|---|---|---|
Mutex |
Single worker, coroutine-scoped | Swoole\Coroutine\Channel(1) |
Serialising access to an in-memory resource per worker |
Semaphore |
Single worker, coroutine-scoped | Swoole\Coroutine\Channel($permits) |
Capping concurrent access (e.g. outbound request pool) |
File |
Single host, cross-process | flock() |
Cron guards, shared-filesystem coordination |
Distributed |
Cross-host, cluster-wide | Redis SET NX EX + Lua release |
Coordinating workers across machines |
Usage
The interface
All primitives implement the same Utopia\Lock\Lock interface:
withLock() throws Utopia\Lock\Exception\Contention if the lock cannot be acquired before the timeout expires.
Mutex
Semaphore
File
Pass LOCK_SH for shared (reader) mode:
Distributed
Release is atomic: a Lua script verifies the lock value still matches this instance's token before deleting, so a lock that expires and is re-acquired elsewhere is never released by accident.
The holder can delegate token-guarded commands to another Redis connection. This is useful when a background coroutine refreshes the lease while the action continues using its own connection:
An adopted token has the same authority as the original instance, including the ability to release the lease. A refresh or release remains safe after the lease expires because the Lua script only acts while the adopted token still matches the value on the key.
Exception handling
Tests
This package is developed in appwrite/appwrite; from that repository run bin/monorepo test lock (unit tier, then the Redis-backed tier against docker-compose.yml) and bin/monorepo check lock.
Security
We take security seriously. If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
Contributing
All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.
We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php