-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
/
SemaphoreInterface.php
61 lines (52 loc) · 1.55 KB
/
SemaphoreInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Semaphore;
use Symfony\Component\Semaphore\Exception\SemaphoreAcquiringException;
use Symfony\Component\Semaphore\Exception\SemaphoreReleasingException;
/**
* SemaphoreInterface defines an interface to manipulate the status of a semaphore.
*
* @experimental in 5.2
*
* @author Jérémy Derussé <jeremy@derusse.com>
* @author Grégoire Pineau <lyrixx@lyrixx.info>
*/
interface SemaphoreInterface
{
/**
* Acquires the semaphore. If the semaphore has reached its limit.
*
* @return bool whether or not the semaphore had been acquired
*
* @throws SemaphoreAcquiringException If the semaphore can not be acquired
*/
public function acquire(): bool;
/**
* Increase the duration of an acquired semaphore.
*
* @throws SemaphoreExpiredException If the semaphore has expired
*/
public function refresh(float $ttlInSecond = null);
/**
* Returns whether or not the semaphore is acquired.
*/
public function isAcquired(): bool;
/**
* Release the semaphore.
*
* @throws SemaphoreReleasingException If the semaphore can not be released
*/
public function release();
public function isExpired(): bool;
/**
* Returns the remaining lifetime.
*/
public function getRemainingLifetime(): ?float;
}