<?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 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.com-message-pump.php',
    1 => 'com_message_pump',
    2 => 'COM メッセージを処理し、timeoutms ミリ秒の間待つ',
  ),
  'up' => 
  array (
    0 => 'ref.com.php',
    1 => 'COM関数',
  ),
  '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' => 'ja',
    '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">COM メッセージを処理し、timeoutms ミリ秒の間待つ</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.com-message-pump-description">
  <h3 class="title">説明</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">
   この関数は、<code class="parameter">timeout_milliseconds</code> ミリ秒が経過するか
   キューにメッセージが到着するまで待機します。
  </p>
  <p class="para">
   この関数の目的は、別々の場所にある COM のコールを振り分け、同期の
   問題をうまく処理することです。これにより、発生するイベントを
   効率的にスクリプトで待ち受けられるようになり、バックグラウンドで
   動作している他のコードやイベントも処理できるようになります。
   COM オブジェクトのイベントを使用している間は、
   <span class="function"><a href="function.com-event-sink.php" class="function">com_event_sink()</a></span> 関数の例で示したように
   この関数をループ内で使用すべきです。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.com-message-pump-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">timeout_milliseconds</code></dt>
     <dd>
      <p class="para">
       タイムアウト。ミリ秒単位で指定します。
      </p>
      <p class="para">
       <code class="parameter">timeout_milliseconds</code> の値を指定しなかった場合は
       0 であるとみなされます。0 という値は、一切待機しないことを
       意味します。処理待ち状態のメッセージがあればそれを処理し、
       なければこの関数はすぐに <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.com-message-pump-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   タイムアウトの前に
   メッセージが到着した場合は、そのメッセージが処理されて
   関数は <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返します。メッセージを処理することなく
   タイムアウトが発生した場合は、この関数は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>

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