streamWrapper::stream_lock
(PHP 5, PHP 7, PHP 8)
streamWrapper::stream_lock — Advisory file locking
Description
$operation): bool
This method is called in response to flock(), when
file_put_contents() (when flags
contains LOCK_EX),
stream_set_blocking() and when closing the stream
(LOCK_UN).
Parameters
-
operation -
operationis one of the following:-
LOCK_SHto acquire a shared lock (reader). -
LOCK_EXto acquire an exclusive lock (writer). -
LOCK_UNto release a lock (shared or exclusive). -
LOCK_NBif you don't want flock() to block while locking. (not supported on Windows)
-
Return Values
Returns true on success or false on failure.
Errors/Exceptions
Emits E_WARNING if call to this method fails (i.e. not implemented).
See Also
- stream_set_blocking() - Set blocking/non-blocking mode on a stream
- flock() - Portable advisory file locking

