LuaSandbox::getCPUUsage

Fetch the current CPU time usage of the Lua environment

Description

public float LuaSandbox::getCPUUsage()

Fetches the current CPU time usage of the Lua environment.

This includes time spent in PHP callbacks.

Parameters

This function has no parameters.

Return Values

Returns the current CPU time usage in seconds.

Note:

On Windows, this function always returns zero. On operating systems that do not support CLOCK_THREAD_CPUTIME_ID, such as FreeBSD and Mac OS X, this function will return the elapsed wall-clock time, not CPU time.

See Also

  • LuaSandbox::getMemoryUsage
  • LuaSandbox::getPeakMemoryUsage
  • LuaSandbox::setCPULimit