Civi/Core/Lock/LockInterface.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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
  29 interface LockInterface {
  30
  31   /**
  32    * @param int|NULL $timeout
  33    *   The number of seconds to wait to get the lock.
  34    *   For a default value, use NULL.
  35    * @return bool
  36    */
  37   public function acquire($timeout = NULL);
  38
  39   /**
  40    * @return bool|null|string
  41    *   Trueish/falsish.
  42    */
  43   public function release();
  44
  45   /**
  46    * @return bool|null|string
  47    *   Trueish/falsish.
  48    * @deprecated
  49    *   Not supported by some locking strategies. If you need to poll, better
  50    *   to use acquire(0).
  51    */
  52   public function isFree();
  53
  54   /**
  55    * @return bool
  56    */
  57   public function isAcquired();
  58
  59 }