com_message_pump()

com_message_pump - Process COM messages, sleeping for up to timeoutms milliseconds

Syntax

bool com_message_pump (int $timeoutms)

Arguments

• timeoutms - The timeout, in milliseconds. If you do not specify a value for timeoutms, then 0 will be assumed. A 0 value means that no waiting will be performed; if there are messages pending they will be dispatched as before; if there are no messages pending, the function will return FALSE immediately without sleeping.

Description

This function will sleep for up to timeoutms milliseconds, or until a message arrives in the queue.

Version

PHP 4.2.0, 5

Return value

If a message or messages arrives before the timeout, they will be dispatched, and the function will return TRUE. If the timeout occurs and no messages were processed, the return value will be FALSE.