com_message_pump — Обработка сообщений COM, пришедших не позднее timeoutms миллисекунд после её запуска

Назначение com_message_pump

com_message_pump: Обработка сообщений COM, пришедших не позднее timeoutms миллисекунд после её запуска. Справочная сущность относится к разделу «com». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается com_message_pump

Это процедурная функция раздела «com». Её отличают имя com_message_pump, контракт «необязательные $timeout_milliseconds» и объявленный результат bool; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление com_message_pump

Смысловое направление com_message_pump — «открытие или запуск». В прикладном коде свяжите успешный результат с обязательным последующим закрытием или завершением. Контрольный набор для этой операции: проверьте повторное открытие и частично созданный ресурс. Такой акцент отделяет com_message_pump от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура com_message_pump

Структурная запись: bool com_message_pump(int $timeout_milliseconds = 0). В ней 1 параметр: необязательные $timeout_milliseconds. Результат объявлен как bool; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры com_message_pump

Порядок и роли аргументов по сигнатуре: 1. $timeout_milliseconds — int, необязателен, default 0. Для com_message_pump фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

Контроль входных данных для com_message_pump

1) int $timeout_milliseconds — необязательный: зафиксируйте единицу измерения и поведение для нуля, отрицательного и предельного значения.

Результат com_message_pump

com_message_pump объявляет результат типа bool. com_message_pump возвращает логическое значение. Назовите ветви успеха и отказа явно и сохраните контекст входных данных для диагностики отрицательного результата.

Проверочный сценарий для com_message_pump

Убедитесь, что раздел «com» доступен в целевой сборке PHP. Сначала выполните контрольный вызов без аргументов. Затем отдельно добавьте необязательные параметры int $timeout_milliseconds=0, чтобы увидеть влияние значений по умолчанию. Для профиля «дата и время» важно фиксировать часовой пояс и формат на границе системы; негативный сценарий должен проверить переход суток, високосную дату и неоднозначное локальное время.

Интеграция com_message_pump в проект

Проверку доступности com_message_pump и преобразование входных значений разместите у границы модуля «com». Для профиля «дата и время» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция com_message_pump не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика com_message_pump

Сначала запишите точную сигнатуру bool com_message_pump(int $timeout_milliseconds = 0) и фактические типы переданных значений. Затем подтвердите загрузку расширения «com» в той же среде, где выполняется com_message_pump. Если результат неожиданен, сравните его тип с bool и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

Границы применения

Для категории «дата и время» применяйте отдельный негативный тест: проверить переход суток, високосную дату и неоднозначное локальное время. В production-коде важно фиксировать часовой пояс и формат на границе системы. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать com_message_pump

Выбор com_message_pump оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «com»; 2) сигнатура содержит 1 аргумент: обязательных 0, необязательных 1; 3) вызывающему коду нужен результат bool и действие «открытие или запуск». Для профиля «дата и время» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с com_event_sink: у него другое назначение, владелец или набор входных данных.

Сравнение com_message_pump с соседними API

Для com_message_pump базовый ориентир: обработка сообщений com, пришедших не позднее timeoutms миллисекунд после её запуска; необязательные $timeout_milliseconds; результат bool. Сопоставление с опубликованными соседями: com_event_sink: связать сообщения объекта com с объектом php; вход — обязательные $variant, $sink_object; необязательные $sink_interface; результат — bool. com_print_typeinfo: печатает определение класса php для интерфейса, наследующего idispatch; вход — обязательные $variant; необязательные $dispatch_interface, $display_sink; результат — bool. com_create_guid: создание уникального глобального идентификатора (guid); вход — аргументов нет; результат — string|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

com_message_pump сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для com_message_pump.

Связанные материалы