Yiisoft\Mutex\RetryAcquireTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	retryAcquire()	0	12	3
A	withRetryDelay()	0	11	2

<?php

declare(strict_types=1);

namespace Yiisoft\Mutex;

use InvalidArgumentException;

use function microtime;
use function usleep;

/**
 * Allows retrying acquire with a certain timeout.
 */
trait RetryAcquireTrait
{
    /**
     * @psalm-var positive-int
     */
    private int $retryDelay = 50;

    /**
     * Returns a new instance with the specified retry delay.
     *
     * @param int $retryDelay Number of milliseconds between each try until specified timeout times out.
     * By default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second.
     *
     * @return self
     */
    public function withRetryDelay(int $retryDelay): self
    {
        if ($retryDelay < 1) {
            throw new InvalidArgumentException(
                "Retry delay value must be a positive number greater than zero, \"$retryDelay\" is received.",
            );
        }

        $new = clone $this;
        $new->retryDelay = $retryDelay;
        return $new;
    }

    private function retryAcquire(int $timeout, callable $callback): bool
    {
        $start = microtime(true);

        do {
            if ($callback()) {
                return true;
            }
            usleep($this->retryDelay * 1000);
        } while (microtime(true) - $start < $timeout);

        return false;
    }
}