core/Concurrency/LockBackend.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

<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */

namespace Piwik\Concurrency;

interface LockBackend
{
    /**
     * Returns lock keys matching a pattern.
     *
     * @param $pattern
     * @return string[]
     */
    public function getKeysMatchingPattern($pattern);

    /**
     * Set a key value if the key is not already set.
     *
     * @param $lockKey
     * @param $lockValue
     * @param $ttlInSeconds
     * @return mixed
     */
    public function setIfNotExists($lockKey, $lockValue, $ttlInSeconds);

    /**
     * Get the lock value for a key if any.
     *
     * @param $lockKey
     * @return mixed
     */
    public function get($lockKey);

    /**
     * Delete the lock with key = $lockKey if the lock has the given value.
     *
     * @param $lockKey
     * @param $lockValue
     * @return mixed
     */
    public function deleteIfKeyHasValue($lockKey, $lockValue);

    /**
     * Update expiration for a lock if the lock with the specified key has the given value.
     *
     * @param $lockKey
     * @param $lockValue
     * @param $ttlInSeconds
     * @return mixed
     */
    public function expireIfKeyHasValue($lockKey, $lockValue, $ttlInSeconds);
}