Функции могут быть вызваны как UseModule("Queue")->function(parameter1,parameter2,...);
| Имя функции | Описание | Параметры |
| Append | Добавление задачи в очередь
 Подробнее...
Добавляет задачу в очередь с параметрами тайм-аута, дедупликации и пакетной записи. | | Тип | Параметр | По умолчанию | Описание | | string | $action | '' | Имя действия, помещаемого в очередь | | array | $params | 'array()' | Параметры действия | | array | $options | 'array()' | Параметры задачи очереди | | boolean | $back | 'false' | Сохранять SQL вставки в пакетном кеше |
|
| AppendBatch | Добавление задачи в очередь batch
Подробнее...
Добавляет несколько задач в очередь с общими параметрами очереди. | | Тип | Параметр | По умолчанию | Описание | | array | $tasks | 'array()' | Список задач с элементами action и params | | array | $options | 'array()' | Общие параметры задач очереди | | boolean | $back | 'false' | Сохранять SQL вставки в пакетном кеше |
|
| AppendMonitors | Добавление задач мониторинга очереди
Подробнее...
Находит модули с включенным мониторингом очереди и добавляет их задачи мониторинга. | Отсутствуют |
| CheckPause | Проверка признака паузы очереди
Подробнее...
Возвращает сохраненный признак паузы модуля очереди. | Отсутствуют |
| ClearDonedTasks | Очистка завершенных задач очереди
Подробнее...
Удаляет завершенные задачи очереди, у которых истек срок хранения после выполнения. | Отсутствуют |
| ClearErroredTasks | Обработка ошибочных задач очереди
Подробнее...
Повторно запускает восстанавливаемые ошибочные задачи и помечает окончательно сбойные задачи как фатальные. | Отсутствуют |
| ClearTimeoutedTasks | Очистка задач очереди по тайм-ауту
Подробнее...
Находит выполняющиеся задачи без недавней активности и переводит их в состояние ошибки. | Отсутствуют |
| GetActionCount | Подсчет задач по действию
Подробнее...
Возвращает количество записей очереди для указанного действия. | | Тип | Параметр | По умолчанию | Описание | | c | $a | 't' | i | | t | $s | 'r' | i | | $ | '' | | | c | $A | 't' | i |
|
| GetDbQ | Открытие базы данных очереди
Подробнее...
Открывает SQLite-базу модуля очереди и при необходимости инициализирует ее схему. | | Тип | Параметр | По умолчанию | Описание | | e | $r | 'a' | d | | o | $b | 'o' | l | | a | $f | 'l' | s | | p | $O | 'e' | n |
|
| GetProgress | Получение прогресса задачи
Подробнее...
Возвращает кешированный прогресс, сообщение прогресса и время последней активности задачи очереди. | | Тип | Параметр | По умолчанию | Описание | | a | $T | 's' | k | | n | $i | 't' | e | | $0 | '' | | | u | $Q | 'e' | u |
|
| GetRecordBlock | Выборка записей очереди
Подробнее...
Читает блок записей из базы очереди по SQL-условиям, переданным вызывающим кодом. | | Тип | Параметр | По умолчанию | Описание | | string | $where | '' | SQL-условие WHERE без ключевого слова WHERE | | integer | $maxcount | '1000' | Максимальное количество строк или 0 без LIMIT | | string | $order | '' | SQL-условие ORDER BY без ключевых слов ORDER BY | | string | $what | '*' | Выражение для выбора столбцов | | string | $group | '' | SQL-условие GROUP BY без ключевых слов GROUP BY |
|
| GetRecordCount | Подсчет записей очереди
Подробнее...
Возвращает количество записей очереди, соответствующих указанному условию. | | Тип | Параметр | По умолчанию | Описание | | h | $w | 'e' | r | | t | $s | 'r' | i | | $ | '' | | | Q | $S | 'L' | |
|
| GetRecordValue | Получение значения записи очереди
Подробнее...
Возвращает одно скалярное значение из базы очереди для указанного столбца и условия. | | Тип | Параметр | По умолчанию | Описание | | string | $column | '' | Selected column expression | | string | $where | '' | SQL-условие WHERE без ключевого слова WHERE |
|
| GetSingleRow | Получение одной строки очереди
Подробнее...
Возвращает одну строку базы очереди, соответствующую указанному условию. | | Тип | Параметр | По умолчанию | Описание | | h | $w | 'e' | r | | t | $s | 'r' | i | | $ | '' | | | Q | $S | 'L' | |
|
| GetTaskForStart | Получение задачи для запуска
Подробнее...
Находит и блокирует следующую ожидающую или высокоприоритетную задачу очереди для рабочего потока. | Отсутствуют |
| GetTaskInfoElm | Получение поля задачи
Подробнее...
Возвращает разрешенное сериализованное поле или время активности задачи очереди. | | Тип | Параметр | По умолчанию | Описание | | integer | $id | '0' | Идентификатор задачи очереди | | string | $name | '' | Имя поля: options, params, result или lastactivity |
|
| MonitorSubTasksProgress | Мониторинг прогресса подзадач
Подробнее...
Ожидает завершения подзадач и обновляет прогресс родительской задачи. | | Тип | Параметр | По умолчанию | Описание | | object | $Task | 'null' | Объект родительской задачи для обновления прогресса | | array | $subtasks | 'array()' | Идентификатор задачи очередиs to monitor | | float | $progressscale | '1' | Масштаб, применяемый к рассчитанному прогрессу | | float | $progressstart | '0' | Начальное смещение прогресса |
|
| SetMonitorLogFile | Установка файла журнала мониторинга
Подробнее...
Сохраняет имя файла журнала, используемого активным монитором задачи очереди. | | Тип | Параметр | По умолчанию | Описание | | o | $l | 'g' | F | | t | $s | 'r' | i | | $ | '' | | | o | $M | 'n' | i |
|
| SetPauseState | Установка признака паузы очереди
Подробнее...
Сохраняет признак паузы очереди и синхронизирует его с кешем. | | Тип | Параметр | По умолчанию | Описание | | a | $p | 'u' | s | | o | $b | 'o' | l | | r | $t | 'u' | e | | e | $N | 'w' | |
|
| SetProgress | Установка прогресса задачи
Подробнее...
Обновляет кешированный прогресс, сообщение прогресса и время активности задачи очереди. | | Тип | Параметр | По умолчанию | Описание | | integer | $Task | '0' | Идентификатор задачи очереди | | float | $progress | '0' | Значение прогресса задачи | | string | $msg | '' | Сообщение прогресса | | integer | $activityTime | 'null' | Необязательное время активности |
|
| SetTaskInfoElm | Установка поля задачи
Подробнее...
Обновляет разрешенное сериализованное поле или время активности задачи очереди. | | Тип | Параметр | По умолчанию | Описание | | integer | $id | '0' | Идентификатор задачи очереди | | string | $name | '' | Имя поля: options, params, result или lastactivity | | mixed | $val | '' | Новое значение поля |
|
| SqlBatch | Выполнение пакетного SQL очереди
Подробнее...
Выполняет SQL-операторы, накопленные вспомогательными методами очереди, в одной транзакции. | Отсутствуют |
| SqlExec | Выполнение SQL очереди
Подробнее...
Выполняет SQL в базе очереди или сохраняет его в пакетном кеше. | | Тип | Параметр | По умолчанию | Описание | | string | $sql | '' | SQL-оператор | | boolean | $back | 'false' | Сохранять SQL в пакетном кеше |
|
| SqlInsert | Вставка строки задачи очереди
Подробнее...
Вставляет строку задачи очереди и инициализирует кешированный статус задачи. | | Тип | Параметр | По умолчанию | Описание | | string | $action | '' | Имя действия, помещаемого в очередь | | array | $params | 'array()' | Параметры действия | | array | $options | 'array()' | Параметры задачи очереди | | string | $dedupstring | '' | Ключ дедупликации | | boolean | $back | 'false' | Сохранять SQL вставки в пакетном кеше |
|
| StartProcessBackground | Запуск диспетчера очереди в фоне
Подробнее...
Отправляет короткий HTTP-запрос, запускающий процесс диспетчера очереди. | | Тип | Параметр | По умолчанию | Описание | | int | $MaxStartedOverride | 0 | Optional temporary dispatcher worker limit |
|
| StartThread | Запуск рабочего потока очереди
Подробнее...
Отправляет короткий HTTP-запрос, запускающий рабочий поток очереди. | | Тип | Параметр | По умолчанию | Описание | | h | $t | 'r' | e | | n | $i | 't' | e | | $0 | '' | | | u | $Q | 'e' | u |
|