flock
Portable advisory file locking
&reftitle.description;
boolflock
resourcehandle
intoperation
intwouldblock
flock allows you to perform a simple reader/writer
model which can be used on virtually every platform (including most Unix
derivatives and even Windows).
On versions of PHP before 5.3.2, the lock is released also by
fclose (which is also called automatically when script
finished).
PHP supports a portable way of locking complete files in an advisory way
(which means all accessing programs have to use the same way of locking
or it will not work). By default, this function will block until the
requested lock is acquired; this may be controlled with the LOCK_NB option documented below.
&reftitle.parameters;
handle
&fs.file.pointer;
operation
operation is one of the following:
LOCK_SH to acquire a shared lock (reader).
LOCK_EX to acquire an exclusive lock (writer).
LOCK_UN to release a lock (shared or exclusive).
It is also possible to add LOCK_NB as a bitmask to one
of the above operations if you don't want flock to
block while locking.
wouldblock
The optional third argument is set to 1 if the lock would block
(EWOULDBLOCK errno condition).
&reftitle.returnvalues;
&return.success;
&reftitle.changelog;
&Version;
&Description;
5.5.22, 5.6.6
Added support for the wouldblock parameter on
Windows.
5.3.2
The automatic unlocking when the file's resource handle is closed was
removed. Unlocking now always has to be done manually.
&reftitle.examples;
flock example
]]>
flock using the LOCK_NB option
]]>
&reftitle.notes;
flock uses mandatory locking instead of advisory
locking on Windows. Mandatory locking is also supported on Linux and
System V based operating systems via the usual mechanism supported by the
fcntl() system call: that is, if the file in question has the setgid
permission bit set and the group execution bit cleared. On Linux, the file
system will also need to be mounted with the mand option for this to work.
Because flock requires a file pointer, you may have
to use a special lock file to protect access to a file that you intend
to truncate by opening it in write mode (with a "w" or "w+" argument to
fopen).
May only be used on file pointers returned by fopen
for local files, or file pointers pointing to userspace streams that
implement the streamWrapper::stream_lock method.
Assigning another value to handle argument in
subsequent code will release the lock.
On some operating systems flock is implemented at
the process level. When using a multithreaded server API like ISAPI you
may not be able to rely on flock to protect files
against other PHP scripts running in parallel threads of the same server
instance!
flock is not supported on antiquated filesystems like
FAT and its derivates and will therefore always
return &false; under this environments (this is especially true for
Windows 98 users).