<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.parallel-events.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'parallel-events.settimeout.php',
    1 => 'parallel\\Events::setTimeout',
    2 => 'Behaviour',
  ),
  'up' => 
  array (
    0 => 'class.parallel-events.php',
    1 => 'parallel\\Events',
  ),
  'prev' => 
  array (
    0 => 'parallel-events.setblocking.php',
    1 => 'parallel\\Events::setBlocking',
  ),
  'next' => 
  array (
    0 => 'parallel-events.setinput.php',
    1 => 'parallel\\Events::setInput',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/parallel/parallel/events/settimeout.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="parallel-events.settimeout" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">parallel\Events::setTimeout</h1>
  <p class="verinfo">(0.9.0)</p><p class="refpurpose"><span class="refname">parallel\Events::setTimeout</span> &mdash; <span class="dc-title">Behaviour</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-parallel-events.settimeout-description">
  <h3 class="title">Description</h3>
  <p class="simpara">
   By default when events are polled for, blocking will occur (at the PHP level) until the first event can be returned: Setting the timeout causes an exception to be
   thrown when the timeout is reached.
  </p>
  <p class="simpara">
   This differs from setting blocking mode to <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> with <span class="methodname"><a href="parallel-events.setblocking.php" class="methodname">parallel\Events::setBlocking()</a></span>, which will not cause an exception to be thrown.
  </p>
  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><strong>parallel\Events::setTimeout</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timeout</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="simpara">
    Shall set the timeout in microseconds
  </p>
 </div>


 <div class="refsect1 exceptions" id="refsect1-parallel-events.settimeout-exceptions">
  <h3 class="title">Exceptions</h3>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    Shall throw <span class="type">parallel\Events\Error</span> if loop is non-blocking.
   </p>
  </div>
 </div>


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