summaryrefslogtreecommitdiffstats
path: root/lib/public/lock
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-06-05 17:30:45 +0200
committerMorris Jobke <hey@morrisjobke.de>2015-06-05 17:30:45 +0200
commit0c9604e3b2b44885647e2bc2edda95329fddbf47 (patch)
treed05c918de3ae7e2d03de1dc72754883c59637dc5 /lib/public/lock
parent9899e10a0411d161db1b4e1302690ac74c1ae72c (diff)
downloadnextcloud-server-0c9604e3b2b44885647e2bc2edda95329fddbf47.tar.gz
nextcloud-server-0c9604e3b2b44885647e2bc2edda95329fddbf47.zip
[OCP] update PHPdoc to contain correct @since tags
Diffstat (limited to 'lib/public/lock')
-rw-r--r--lib/public/lock/ilockingprovider.php17
-rw-r--r--lib/public/lock/lockedexception.php8
2 files changed, 25 insertions, 0 deletions
diff --git a/lib/public/lock/ilockingprovider.php b/lib/public/lock/ilockingprovider.php
index 6a963b9d7aa..fd2aa615452 100644
--- a/lib/public/lock/ilockingprovider.php
+++ b/lib/public/lock/ilockingprovider.php
@@ -21,14 +21,27 @@
namespace OCP\Lock;
+/**
+ * Interface ILockingProvider
+ *
+ * @package OCP\Lock
+ * @since 8.1.0
+ */
interface ILockingProvider {
+ /**
+ * @since 8.1.0
+ */
const LOCK_SHARED = 1;
+ /**
+ * @since 8.1.0
+ */
const LOCK_EXCLUSIVE = 2;
/**
* @param string $path
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @return bool
+ * @since 8.1.0
*/
public function isLocked($path, $type);
@@ -36,12 +49,14 @@ interface ILockingProvider {
* @param string $path
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @throws \OCP\Lock\LockedException
+ * @since 8.1.0
*/
public function acquireLock($path, $type);
/**
* @param string $path
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+ * @since 8.1.0
*/
public function releaseLock($path, $type);
@@ -51,11 +66,13 @@ interface ILockingProvider {
* @param string $path
* @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @throws \OCP\Lock\LockedException
+ * @since 8.1.0
*/
public function changeLock($path, $targetType);
/**
* release all lock acquired by this instance
+ * @since 8.1.0
*/
public function releaseAll();
}
diff --git a/lib/public/lock/lockedexception.php b/lib/public/lock/lockedexception.php
index 87f7164b7e0..f8a0221f10b 100644
--- a/lib/public/lock/lockedexception.php
+++ b/lib/public/lock/lockedexception.php
@@ -21,6 +21,12 @@
namespace OCP\Lock;
+/**
+ * Class LockedException
+ *
+ * @package OCP\Lock
+ * @since 8.1.0
+ */
class LockedException extends \Exception {
/**
* @var string
@@ -31,6 +37,7 @@ class LockedException extends \Exception {
* LockedException constructor.
*
* @param string $path
+ * @since 8.1.0
*/
public function __construct($path) {
parent::__construct($path . ' is locked');
@@ -39,6 +46,7 @@ class LockedException extends \Exception {
/**
* @return string
+ * @since 8.1.0
*/
public function getPath() {
return $this->path;