RetryAcquireTrait::retryAcquire() - Code Metrics - yiisoft/mutex - Measure and Improve Code Quality continuously with Scrutinizer

RetryAcquireTrait::retryAcquire() A
last analyzed 2025-03-06 17:29 UTC

↳ Parent: RetryAcquireTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	7
c	0
b	0
f	0
nc	2
nop	2
dl	0
loc	12
ccs	7
cts	7
cp	1
crap	3
rs	10

<?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;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Mutex;
6
7		use InvalidArgumentException;
8
9		use function microtime;
10		use function usleep;
11
12		/**
13		* Allows retrying acquire with a certain timeout.
14		*/
15		trait RetryAcquireTrait
16		{
17		/**
18		* @psalm-var positive-int
19		*/
20		private int $retryDelay = 50;
21
22		/**
23		* Returns a new instance with the specified retry delay.
24		*
25		* @param int $retryDelay Number of milliseconds between each try until specified timeout times out.
26		* By default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second.
27		*
28		* @return self
29		*/
30	4	public function withRetryDelay(int $retryDelay): self
31		{
32	4	if ($retryDelay < 1) {
33	1	throw new InvalidArgumentException(
34	1	"Retry delay value must be a positive number greater than zero, \"$retryDelay\" is received.",
35	1	);
36		}
37
38	3	$new = clone $this;
39	3	$new->retryDelay = $retryDelay;
40	3	return $new;
41		}
42
43	13	private function retryAcquire(int $timeout, callable $callback): bool
44		{
45	13	$start = microtime(true);
46
47		do {
48	13	if ($callback()) {
49	12	return true;
50		}
51	6	usleep($this->retryDelay * 1000);
52	6	} while (microtime(true) - $start < $timeout);
53
54	5	return false;
55		}
56		}
57

yiisoft / mutex

RetryAcquireTrait::retryAcquire() A last analyzed 2025-03-06 17:29 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RetryAcquireTrait::retryAcquire() A
last analyzed 2025-03-06 17:29 UTC