<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.luasandbox.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'luasandbox.pauseusagetimer.php',
    1 => 'LuaSandbox::pauseUsageTimer',
    2 => 'Pause the CPU usage timer',
  ),
  'up' => 
  array (
    0 => 'class.luasandbox.php',
    1 => 'LuaSandbox',
  ),
  'prev' => 
  array (
    0 => 'luasandbox.loadstring.php',
    1 => 'LuaSandbox::loadString',
  ),
  'next' => 
  array (
    0 => 'luasandbox.registerlibrary.php',
    1 => 'LuaSandbox::registerLibrary',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/luasandbox/luasandbox/pauseusagetimer.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="luasandbox.pauseusagetimer" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">LuaSandbox::pauseUsageTimer</h1>
  <p class="verinfo">(PECL luasandbox &gt;= 1.4.0)</p><p class="refpurpose"><span class="refname">LuaSandbox::pauseUsageTimer</span> &mdash; <span class="dc-title">Pause the CPU usage timer</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-luasandbox.pauseusagetimer-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>LuaSandbox::pauseUsageTimer</strong></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Pauses the CPU usage timer.
  </p>
  <p class="simpara">
   This only has effect when called from within a callback from Lua. When
   execution returns to Lua, the timer will be automatically unpaused. If
   a new call into Lua is made, the timer will be unpaused for the
   duration of that call.
  </p>
  <p class="simpara">
   If a PHP callback calls into Lua again with timer not paused, and then
   that Lua function calls into PHP again, the second PHP call will not be
   able to pause the timer. The logic is that even though the second PHP
   call would avoid counting the CPU usage against the limit, the first
   call still counts it.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-luasandbox.pauseusagetimer-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <p class="para">Diese Funktion besitzt keine Parameter.</p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-luasandbox.pauseusagetimer-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="simpara">
   Returns a <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> indicating whether the timer is now paused.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-luasandbox.pauseusagetimer-examples">
  <h3 class="title">Beispiele</h3>
  <div class="example" id="example-1">
   <p><strong>Beispiel #1 Manipulating the usage timer</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// create a new LuaSandbox and set a CPU limit<br /></span><span style="color: #0000BB">$sandbox </span><span style="color: #007700">= new </span><span style="color: #0000BB">LuaSandbox</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setCPULimit</span><span style="color: #007700">( </span><span style="color: #0000BB">1 </span><span style="color: #007700">);<br /><br />function </span><span style="color: #0000BB">doWait</span><span style="color: #007700">( </span><span style="color: #0000BB">$t </span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$end </span><span style="color: #007700">= </span><span style="color: #0000BB">microtime</span><span style="color: #007700">( </span><span style="color: #0000BB">true </span><span style="color: #007700">) + </span><span style="color: #0000BB">$t</span><span style="color: #007700">;<br />    while ( </span><span style="color: #0000BB">microtime</span><span style="color: #007700">( </span><span style="color: #0000BB">true </span><span style="color: #007700">) &lt; </span><span style="color: #0000BB">$end </span><span style="color: #007700">) {<br />        </span><span style="color: #FF8000">// waste CPU cycles<br />    </span><span style="color: #007700">}<br />}<br /><br /></span><span style="color: #FF8000">// Register a PHP callback<br /></span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">registerLibrary</span><span style="color: #007700">( </span><span style="color: #DD0000">'php'</span><span style="color: #007700">, [<br />    </span><span style="color: #DD0000">'test' </span><span style="color: #007700">=&gt; function () use ( </span><span style="color: #0000BB">$sandbox </span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">pauseUsageTimer</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">doWait</span><span style="color: #007700">( </span><span style="color: #0000BB">5 </span><span style="color: #007700">);<br /><br />        </span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unpauseUsageTimer</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">doWait</span><span style="color: #007700">( </span><span style="color: #0000BB">0.1 </span><span style="color: #007700">);<br />    },<br />    </span><span style="color: #DD0000">'test2' </span><span style="color: #007700">=&gt; function () use ( </span><span style="color: #0000BB">$sandbox </span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">pauseUsageTimer</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unpauseUsageTimer</span><span style="color: #007700">();<br />        </span><span style="color: #0000BB">doWait</span><span style="color: #007700">( </span><span style="color: #0000BB">1.1 </span><span style="color: #007700">);<br />    }<br />] );<br /><br />echo </span><span style="color: #DD0000">"This should not time out...\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">loadString</span><span style="color: #007700">( </span><span style="color: #DD0000">'php.test()' </span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">call</span><span style="color: #007700">();<br /><br />echo </span><span style="color: #DD0000">"This should time out.\n"</span><span style="color: #007700">;<br />try {<br />    </span><span style="color: #0000BB">$sandbox</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">loadString</span><span style="color: #007700">( </span><span style="color: #DD0000">'php.test2()' </span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">call</span><span style="color: #007700">();<br />    echo </span><span style="color: #DD0000">"It did not?\n"</span><span style="color: #007700">;<br />} catch ( </span><span style="color: #0000BB">LuaSandboxTimeoutError $ex </span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">"It did! " </span><span style="color: #007700">. </span><span style="color: #0000BB">$ex</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getMessage</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>Das oben gezeigte Beispiel erzeugt folgende Ausgabe:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">This should not time out...
This should time out.
It did! The maximum execution time for this script was exceeded</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-luasandbox.pauseusagetimer-seealso">
  <h3 class="title">Siehe auch</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="luasandbox.setcpulimit.php" class="methodname" rel="rdfs-seeAlso">LuaSandbox::setCPULimit()</a> - Set the CPU time limit for the Lua environment</span></li>
   <li><span class="methodname"><a href="luasandbox.unpauseusagetimer.php" class="methodname" rel="rdfs-seeAlso">LuaSandbox::unpauseUsageTimer()</a> - Unpause the timer paused by LuaSandbox::pauseUsageTimer</span></li>
  </ul>
 </div>


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