LuaSandbox::setCPULimit

Set the CPU time limit for the Lua environment

&reftitle.description; public `void` `LuaSandbox::setCPULimit` ``float``bool```limit`

Sets the CPU time limit for the Lua environment.

If the total user and system time used by the environment after the call to this method exceeds this limit, a `LuaSandboxTimeoutError` exception is thrown.

Time used in PHP callbacks is included in the limit.

Setting the time limit from a callback while Lua is running causes the timer to be reset, or started if it was not already running.

On Windows, the CPU limit will be ignored. On operating systems that do not support `CLOCK_THREAD_CPUTIME_ID`, such as FreeBSD and Mac OS X, wall-clock time rather than CPU time will be limited.

&reftitle.parameters;

`limit`

- Limit as a `float` in seconds, or &false; for no limit.

&reftitle.returnvalues;

&return.void;

&reftitle.examples;

### Calling a Lua function

    <?php

    // create a new LuaSandbox
    $sandbox = new LuaSandbox();

    // set a time limit
    $sandbox->setCPULimit( 2 );

    // Run Lua code
    $sandbox->loadString( 'while true do end' )->call();

    ?>

&example.outputs.similar;

    PHP Fatal error:  Uncaught LuaSandboxTimeoutError: The maximum execution time for this script was exceeded

&reftitle.seealso;

- `LuaSandbox::getCPUUsage`
- `LuaSandbox::setMemoryLimit`