Установить именованную блокировку Connection::lock
Модуль: main — подключать отдельно не нужно
Метод Connection::lock устанавливает глобальную именованную блокировку. Блокировка не дает двум процессам одновременно выполнять один и тот же участок кода, например обработку очереди. Метод unlock снимает блокировку.
Сигнатура метода в классе Bitrix\Main\DB\Connection:
public function lock($name, $timeout = 0)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| name* | string |
Задает имя блокировки. Метод строит имя блокировки на сервере из хеша уникального идентификатора установки и хеша name |
| timeout | int |
Задает время ожидания блокировки в секундах. По умолчанию — 0. В MySQL при 0 метод не ждет, а отрицательное значение означает ожидание без ограничения. По комментарию в коде отрицательное значение не работает в MariaDB |
Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.
Возвращаемое значение
Метод возвращает true, если блокировка установлена, иначе false.
| Реализация | Как устанавливает блокировку |
|---|---|
Connection |
Базовая реализация ничего не делает и возвращает true |
MysqliConnection |
Выполняет GET_LOCK на основном сервере, даже если включены реплики. Имя на сервере — два хеша md5. Возвращает true, только если функция вернула 1 |
PgsqlConnection |
Вызывает функцию базы данных bx_get_lock. Имя на сервере — число crc32, поэтому разные имена могут совпасть. Возвращает true, если функция вернула 0 |
Исключения
| Исключение | Когда возникает |
|---|---|
Bitrix\Main\DB\SqlQueryException |
База данных вернула ошибку при выполнении запроса |
Bitrix\Main\DB\ConnectionException |
Подключиться к базе данных не удалось |
Примеры
Пример. Код обрабатывает очередь, только если получил блокировку. Блок finally снимает блокировку при любом исходе:
<?php
use Bitrix\Main\Application;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$connection = Application::getConnection();
if ($connection->lock('demo_api_queue', 5))
{
try
{
echo 'Processing the queue';
}
finally
{
$connection->unlock('demo_api_queue');
}
}
else
{
echo 'Another process is running';
}
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая