streamWrapper::stream_lock

(PHP 5, PHP 7, PHP 8)

streamWrapper::stream_lockКонсультативная блокировка файла

Описание

public function streamWrapper::stream_lock(int $operation): bool

Этот метод вызывается в ответ на flock(), когда вызывается file_put_contents() (если flags содержит LOCK_EX), stream_set_blocking() или при закрытии потока (LOCK_UN).

Список параметров

operation

operation может принимать одно из следующих значений:

  • LOCK_SH установить общую блокировку (для чтения).
  • LOCK_EX установить эксклюзивную блокировку (для записи).
  • LOCK_UN снять блокировку (общую или эксклюзивную).

Также можно добавить константу LOCK_NB в виде битовой маски к одной из перечисленных выше операций, если при попытке установить блокировку она не должна блокировать выполнение (не поддерживается в Windows).

Возвращаемые значения

Функция возвращает true, если выполнилась успешно, или false, если возникла ошибка.

Ошибки

Вызывает ошибку E_WARNING, если вызов метода не удался (то есть метод не реализован).

Смотрите также

  • stream_set_blocking() - Устанавливает блокирующий или неблокирующий режим для потока
  • flock() - Блокирует файл методом переносимой рекомендательной блокировки