com_message_pump

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

com_message_pumpTraite un message COM dans un délai donné

Description

com_message_pump(int $timeout_milliseconds = 0): bool

Traite un message COM en attendant jusqu'à timeout_milliseconds millisecondes, ou bien en attendant qu'un message arrive dans la file d'attente.

Le but de cette fonction est d'acheminer les appels COM entre les éléments et de gérer les différentes synchronisations. Cela permet au script d'attendre efficacement les événements à déclencher, tout en gérant d'autres événements ou bien d'exécuter d'autres scripts en arrière-plan. Il est recommandé de l'utiliser dans une boucle, comme dans l'exemple de la fonction com_event_sink(), jusqu'à ce que l'on ait fini d'utiliser les objets COM liés à des événements.

Liste de paramètres

timeout_milliseconds

Le délai, en millisecondes.

Si l'on ne spécifie pas de valeur pour le paramètre timeout_milliseconds, alors la valeur 0 sera utilisée. Une valeur à 0 signifie que les messages seront traités immédiatement ; s'il y a des messages dans la file d'attente, ils seront distribués aussitôt ; s'il n'y a aucun message dans la file d'attente, la fonction retourne false immédiatement sans attendre.

Valeurs de retour

Si un ou plusieurs messages arrivent avant le délai d'expiration, ils seront distribués et la fonction retourne true. Si le délai d'expiration survient et qu'aucun message n'est traité, la valeur retournée sera false.

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top