<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.com.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.com-message-pump.php',
    1 => 'com_message_pump',
    2 => 'Traite un message COM dans un d&eacute;lai donn&eacute;',
  ),
  'up' => 
  array (
    0 => 'ref.com.php',
    1 => 'Fonctions COM et .Net (Windows)',
  ),
  'prev' => 
  array (
    0 => 'function.com-load-typelib.php',
    1 => 'com_load_typelib',
  ),
  'next' => 
  array (
    0 => 'function.com-print-typeinfo.php',
    1 => 'com_print_typeinfo',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/com/functions/com-message-pump.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.com-message-pump" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">com_message_pump</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">com_message_pump</span> &mdash; <span class="dc-title">Traite un message COM dans un délai donné</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.com-message-pump-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>com_message_pump</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout_milliseconds</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Traite un message COM en attendant jusqu&#039;à <code class="parameter">timeout_milliseconds</code>
   millisecondes, ou bien en attendant qu&#039;un message arrive dans la file
   d&#039;attente.
  </p>
  <p class="para">
   Le but de cette fonction est d&#039;acheminer les appels COM entre les éléments et de
   gérer les différentes synchronisations. Cela permet au script
   d&#039;attendre efficacement les événements à déclencher, tout en gérant
   d&#039;autres événements ou bien d&#039;exécuter d&#039;autres scripts en arrière-plan.
   Il est recommandé de l&#039;utiliser dans une boucle, comme dans l&#039;exemple de la fonction
   <span class="function"><a href="function.com-event-sink.php" class="function">com_event_sink()</a></span>, jusqu&#039;à ce que l&#039;on ait fini
   d&#039;utiliser les objets COM liés à des événements.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.com-message-pump-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">timeout_milliseconds</code></dt>
     <dd>
      <p class="para">
       Le délai, en millisecondes.
      </p>
      <p class="para">
       Si l&#039;on ne spécifie pas de valeur pour le paramètre
       <code class="parameter">timeout_milliseconds</code>, alors la valeur 0 sera utilisée.
       Une valeur à 0 signifie que les messages seront traités immédiatement ;
       s&#039;il y a des messages dans la file d&#039;attente, ils seront distribués aussitôt ;
       s&#039;il n&#039;y a aucun message dans la file d&#039;attente, la fonction retourne <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
       immédiatement sans attendre.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.com-message-pump-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Si un ou plusieurs messages arrivent avant le délai d&#039;expiration,
   ils seront distribués et la fonction retourne <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. Si le délai d&#039;expiration
   survient et qu&#039;aucun message n&#039;est traité, la valeur retournée sera <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>

</div><?php manual_footer($setup); ?>