makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-10 13:28:55 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/10103] Correct flock class documentation.

Browse source 
PHPBB3-10103
This commit is contained in:
Oleg Pudeyev 2012-12-04 13:44:22 -05:00
parent fc410e1cd0
commit 4cc81f1ffa
1 changed files with 13 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
phpBB/includes/lock/flock.php
View file

@ -35,9 +35,9 @@ class phpbb_lock_flock
private $lock_fp;
/**
* Creates an instance of the lock.
* Constructor.
*
* You have to call acquire() to actually create the lock.
* You have to call acquire() to actually acquire the lock.
*
* @param string $path Path to the file access to which is controlled
*/
@ -50,8 +50,17 @@ class phpbb_lock_flock
/**
* Tries to acquire the lock.
*
* As a lock may only be held by one process at a time, lock
* acquisition may fail if another process is holding the lock.
* If the lock is already held by another process, this call will block
* until the other process releases the lock. If a lock is acquired and
* is not released before script finishes but the process continues to
* live (apache/fastcgi) then subsequent processes trying to acquire
* the same lock will be blocked forever.
*
* If the lock is already held by the same process via another instance
* of this class, this call will block forever.
*
* If flock function is disabled in php or fails to work, lock
* acquisition will fail and false will be returned.
*
* @return bool true if lock was acquired
* false otherwise