Commit fa07d313 by Carsten Brandt

documentation fixed for mutex extension

parent 147558ea
...@@ -18,7 +18,7 @@ class FileMutex extends Mutex ...@@ -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 ...@@ -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.
*/ */
......
...@@ -45,6 +45,7 @@ abstract class Mutex extends Component ...@@ -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.
......
...@@ -29,7 +29,7 @@ class MysqlMutex extends Mutex ...@@ -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 ...@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment