Commit | Line | Data |
---|---|---|
10760fa1 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
10760fa1 | 5 | +--------------------------------------------------------------------+ |
8c9251b3 | 6 | | Copyright CiviCRM LLC (c) 2004-2018 | |
10760fa1 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | namespace Civi\Core\Lock; | |
28 | ||
e8e8f3ad | 29 | /** |
30 | * Lock interface. | |
31 | */ | |
10760fa1 TO |
32 | interface LockInterface { |
33 | ||
34 | /** | |
e8e8f3ad | 35 | * Acquire lock. |
36 | * | |
10760fa1 TO |
37 | * @param int|NULL $timeout |
38 | * The number of seconds to wait to get the lock. | |
39 | * For a default value, use NULL. | |
40 | * @return bool | |
41 | */ | |
42 | public function acquire($timeout = NULL); | |
43 | ||
44 | /** | |
45 | * @return bool|null|string | |
46 | * Trueish/falsish. | |
47 | */ | |
48 | public function release(); | |
49 | ||
50 | /** | |
51 | * @return bool|null|string | |
52 | * Trueish/falsish. | |
53 | * @deprecated | |
54 | * Not supported by some locking strategies. If you need to poll, better | |
55 | * to use acquire(0). | |
56 | */ | |
57 | public function isFree(); | |
58 | ||
59 | /** | |
60 | * @return bool | |
61 | */ | |
62 | public function isAcquired(); | |
b7c4f29b | 63 | |
10760fa1 | 64 | } |