KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #claude-code #codex #cli #agent-skills #ai #dsh-plugin #mcp #windows #agent

mutex

★ 33 Open GitHub ↗

Mutex lock implementation

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
    <a href="https://github.com/yiisoft" target="_blank">
        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
    </a>
    <h1 align="center">Yii Mutex</h1>
    <br>
</p>

[![Latest Stable Version](https://poser.pugx.org/yiisoft/mutex/v)](https://packagist.org/packages/yiisoft/mutex)
[![Total Downloads](https://poser.pugx.org/yiisoft/mutex/downloads)](https://packagist.org/packages/yiisoft/mutex)
[![Build status](https://github.com/yiisoft/mutex/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/mutex/actions/workflows/build.yml)
[![Code Coverage](https://codecov.io/gh/yiisoft/mutex/branch/master/graph/badge.svg)](https://codecov.io/gh/yiisoft/mutex)
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fmutex%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/mutex/master)
[![Static analysis](https://github.com/yiisoft/mutex/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/mutex/actions/workflows/static.yml?query=branch%3Amaster)
[![type-coverage](https://shepherd.dev/github/yiisoft/mutex/coverage.svg)](https://shepherd.dev/github/yiisoft/mutex)

This package provides mutex implementation and allows mutual execution of concurrent processes in order to prevent
"race conditions".

This is achieved by using a "lock" mechanism. Each possibly concurrent processes cooperates by acquiring
a lock before accessing the corresponding data.

## Requirements

- PHP 7.4 or higher.

## Installation

The package could be installed with [Composer](https://getcomposer.org):

```shell
composer require yiisoft/mutex
```

## General usage

There are multiple ways you can use the package. You can execute a callback in a synchronized mode i.e. only a
single instance of the callback is executed at the same time:

```php
/** @var \Yiisoft\Mutex\Synchronizer $synchronizer */
$newCount = $synchronizer->execute('critical', function () {
    return $counter->increase();
}, 10);
```

Another way is to manually open and close mutex:

```php
/** @var \Yiisoft\Mutex\SimpleMutex $simpleMutex */
if (!$simpleMutex->acquire('critical', 10)) {
    throw new \Yiisoft\Mutex\Exception\MutexLockedException('Unable to acquire the "critical" mutex.');
}
$newCount = $counter->increase();
$simpleMutex->release('critical');
```

It could be done on lower level:

```php
/** @var \Yiisoft\Mutex\MutexFactoryInterface $mutexFactory */
$mutex = $mutexFactory->createAndAcquire('critical', 10);
$newCount = $counter->increase();
$mutex->release();
```

And if you want even more control, you can acquire mutex manually:

```php
/** @var \Yiisoft\Mutex\MutexFactoryInterface $mutexFactory */
$mutex = $mutexFactory->create('critical');
if (!$mutex->acquire(10)) {
    throw new \Yiisoft\Mutex\Exception\MutexLockedException('Unable to acquire the "critical" mutex.');
}
$newCount = $counter->increase();
$mutex->release();
```

## Mutex drivers

There are some mutex drivers available as separate packages:

- [File](https://github.com/yiisoft/mutex-file)
- [PDO MySQL](https://github.com/yiisoft/mutex-pdo-mysql)
- [PDO Oracle](https://github.com/yiisoft/mutex-pdo-oracle)
- [PDO Postgres](https://github.com/yiisoft/mutex-pdo-pgsql)
- [Redis](https://github.com/yiisoft/mutex-redis)

If you want to provide your own driver, you need to implement `MutexFactoryInterface` and `MutexInterface`.
There is ready to extend `Mutex`, `MutexFactory` and a `RetryAcquireTrait` that contains `retryAcquire()`
method implementing the "wait for a lock for a certain time" functionality.

When implementing your own drivers, you need to take care of automatic unlocking. For example using a destructor:

```php
public function __destruct()
{
    $this->release();
}
```

and shutdown function:

```php
public function __construct()
{
    register_shutdown_function(function () {
        $this->release();
    });
}
```

Note that you should not call the `exit()` or `die()` functions in the destructor or shutdown function. Since calling
these functions in the destructor and shutdown function will prevent all subsequent completion functions from executing.

## Documentation

- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for
that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## License

The Yii Mutex is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

## Follow updates

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)

mutex

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README