Browse Source

documentation fixed for mutex extension

tags/2.0.0-beta
Carsten Brandt 11 years ago
parent
commit
fa07d31310
  1. 4
      extensions/mutex/yii/mutex/FileMutex.php
  2. 1
      extensions/mutex/yii/mutex/Mutex.php
  3. 4
      extensions/mutex/yii/mutex/MysqlMutex.php

4
extensions/mutex/yii/mutex/FileMutex.php

@ -18,7 +18,7 @@ class FileMutex extends Mutex
{ {
/** /**
* @var string the directory to store mutex files. You may use path alias here. * @var string the directory to store mutex files. You may use path alias here.
* If not set, it will use the "mutex" subdirectory under the application runtime path. * Defaults to the "mutex" subdirectory under the application runtime path.
*/ */
public $mutexPath = '@runtime/mutex'; public $mutexPath = '@runtime/mutex';
/** /**
@ -69,7 +69,7 @@ class FileMutex extends Mutex
} }
/** /**
* This method should be extended by concrete mutex implementations. Releases lock by given name. * Releases lock by given name.
* @param string $name of the lock to be released. * @param string $name of the lock to be released.
* @return boolean release result. * @return boolean release result.
*/ */

1
extensions/mutex/yii/mutex/Mutex.php

@ -45,6 +45,7 @@ abstract class Mutex extends Component
} }
/** /**
* Acquires lock by given name.
* @param string $name of the lock to be acquired. Must be unique. * @param string $name of the lock to be acquired. Must be unique.
* @param integer $timeout to wait for lock to be released. Defaults to zero meaning that method will return * @param integer $timeout to wait for lock to be released. Defaults to zero meaning that method will return
* false immediately in case lock was already acquired. * false immediately in case lock was already acquired.

4
extensions/mutex/yii/mutex/MysqlMutex.php

@ -29,7 +29,7 @@ class MysqlMutex extends Mutex
} }
/** /**
* This method should be extended by concrete mutex implementations. Acquires lock by given name. * Acquires lock by given name.
* @param string $name of the lock to be acquired. * @param string $name of the lock to be acquired.
* @param integer $timeout to wait for lock to become released. * @param integer $timeout to wait for lock to become released.
* @return boolean acquiring result. * @return boolean acquiring result.
@ -43,7 +43,7 @@ class MysqlMutex extends Mutex
} }
/** /**
* This method should be extended by concrete mutex implementations. Releases lock by given name. * Releases lock by given name.
* @param string $name of the lock to be released. * @param string $name of the lock to be released.
* @return boolean release result. * @return boolean release result.
* @see http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock * @see http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock

Loading…
Cancel
Save