com_message_pump

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

com_message_pump — Processa mensagens COM, aguardando por um tempo limite

Descrição

com_message_pump(int $timeout_milliseconds = 0): bool

Esta função ficará suspensa por até timeout_milliseconds milissegundos ou até que uma mensagem chegue na fila.

O objetivo desta função é rotear chamadas COM entre seções e lidar com vários problemas de sincronização. Isso permite que o script aguarde com eficiência o acionamento de eventos, enquanto ainda manipula outros eventos ou executa outro código em segundo plano. Deve ser usada em um laçp de repetição, conforme demonstrado pelo exemplo na função com_event_sink(), até terminar de usar objetos COM vinculados a eventos.

Parâmetros

timeout_milliseconds

O tempo limite, em milissegundos.

Se não for especificafo um valor para timeout_milliseconds, será assumido 0. Um valor 0 significa que nenhuma espera será realizada; se houver mensagens pendentes elas serão despachadas como antes; se não houver mensagens pendentes, a função retornará false imediatamente sem ser suspensa.

Valor Retornado

Se uma mensagem ou mensagens chegarem antes do tempo limite, elas serão despachadas e a função retornará true. Se o tempo limite ocorrer e nenhuma mensagem for processada, o valor de retorno será false.