Yiisoft\Mutex\Synchronizer

Complexity

Total Complexity

3

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	execute()	0	12	2

<?php

declare(strict_types=1);

namespace Yiisoft\Mutex;

use RuntimeException;

/**
 * Executes a callback in synchronized mode, i.e. only a single instance of the callback is executed at the same time:
 *
 * ```php
 * $newCount = $synchronizer->execute('critical', function () {
 *     return $counter->increase();
 * }, 10);
 * ```
 */
final class Synchronizer
{
    private MutexFactoryInterface $mutexFactory;

    public function __construct(MutexFactoryInterface $mutexFactory)
    {
        $this->mutexFactory = $mutexFactory;
    }

    /**
     * Executes a PHP callable with a lock and returns the result.
     *
     * @param string $name Name of the mutex to acquire.
     * @param callable $callback PHP callable to execution.
     * @param int $timeout Time (in seconds) to wait for lock to be released. Defaults to zero meaning that
     * method {@see MutexInterface::acquire()} will return false immediately in case lock was already acquired.
     *
     * @return mixed The result of the PHP callable execution.
     */
    public function execute(string $name, callable $callback, int $timeout = 0)
    {
        $mutex = $this->mutexFactory->create($name);

        if (!$mutex->acquire($timeout)) {
            throw new RuntimeException("Unable to execute synchronized \"$name\".");
        }

        /** @var mixed $result */
        $result = $callback();
        $mutex->release();
        return $result;
    }
}