php man page for wincache_lock

WINCACHE_LOCK(3)							 1							  WINCACHE_LOCK(3)

wincache_lock - Acquires an exclusive lock on a given key

SYNOPSIS
       bool wincache_lock (string  $key, [bool	$isglobal = false])

DESCRIPTION
	Obtains  an  exclusive	lock  on a given key. The execution of the current script will be blocked until the lock can be obtained. Once the
       lock is obtained, the other scripts that try to request the lock by using the same key will be blocked, until the current  script  releases
       the lock by using wincache_unlock(3).

       Warning

	       Using  of the wincache_lock(3) and wincache_unlock(3) can cause deadlocks when executing PHP scripts in a multi-process environment
	      like FastCGI. Do not use these functions unless you are absolutely sure you need to use them. For the majority of the operations	on
	      the user cache it is not necessary to use these functions.

PARAMETERS
	      o $key
		- Name of the key in the cache to get the lock on.

	      o $isglobal
		-  Controls  whether  the scope of the lock is system-wide or local. Local locks are scoped to the application pool in IIS FastCGI
		case or to all php processes that have the same parent process identifier.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      Using wincache_lock(3)

	      <?php
	      $fp = fopen("/tmp/lock.txt", "r+");
	      if (wincache_lock("lock_txt_lock")) { // do an exclusive lock
		  ftruncate($fp, 0); // truncate file
		  fwrite($fp, "Write something here
");
		  wincache_unlock("lock_txt_lock"); // release the lock
	      } else {
		  echo "Couldn't get the lock!";
	      }
	      fclose($fp);
	      ?>

SEE ALSO
       wincache_unlock(3),   wincache_ucache_set(3),	wincache_ucache_get(3),    wincache_ucache_delete(3),	 wincache_ucache_clear(3),    win-
       cache_ucache_exists(3), wincache_ucache_meminfo(3), wincache_ucache_info(3), wincache_scache_info(3).

PHP Documentation Group 													  WINCACHE_LOCK(3)