TeamSpeak3_Helper_Profiler_Timer Class Reference

Helper class providing profiler timers. More...

Public Member Functions
	__construct ($name)
	The TeamSpeak3_Helper_Profiler_Timer constructor. More...
	getMemUsage ($realmem=FALSE)
	Returns the amount of memory allocated to PHP in bytes. More...
	getRuntime ()
	Return the timer runtime. More...
	isRunning ()
	Returns TRUE if the timer is running. More...
	start ()
	Starts the timer. More...
	stop ()
	Stops the timer. More...

Detailed Description

Helper class providing profiler timers.

Constructor & Destructor Documentation

__construct()

__construct

(

$name

)

The TeamSpeak3_Helper_Profiler_Timer constructor.

Parameters

string

$name

Returns

TeamSpeak3_Helper_Profiler_Timer

  {
    $this->name = (string) $name;

    $this->data["runtime"] = 0;
    $this->data["realmem"] = 0;
    $this->data["emalloc"] = 0;

    $this->start();
  }

Member Function Documentation

getMemUsage()

getMemUsage

(

$realmem = FALSE

)

Returns the amount of memory allocated to PHP in bytes.

Parameters

boolean

$realmem

Returns

integer

  {
    if($this->isRunning())
    {
      $this->stop();
      $this->start();
    }

    return ($realmem !== FALSE) ? $this->data["realmem"] : $this->data["emalloc"];
  }

getRuntime()

getRuntime

(

)

Return the timer runtime.

Returns

mixed

  {
    if($this->isRunning())
    {
      $this->stop();
      $this->start();
    }

    return $this->data["runtime"];
  }

isRunning()

isRunning

(

)

Returns TRUE if the timer is running.

Returns

boolean

  {
    return $this->running;
  }

start()

start

(

)

Starts the timer.

Returns

void

  {
    if($this->isRunning()) return;

    $this->data["realmem_start"] = memory_get_usage(TRUE);
    $this->data["emalloc_start"] = memory_get_usage();

    $this->started = microtime(TRUE);
    $this->running = TRUE;
  }

stop()

stop

(

)

Stops the timer.

Returns

void

  {
    if(!$this->isRunning()) return;

    $this->data["runtime"] += microtime(TRUE) - $this->started;
    $this->data["realmem"] += memory_get_usage(TRUE) - $this->data["realmem_start"];
    $this->data["emalloc"] += memory_get_usage() - $this->data["emalloc_start"];

    $this->started = 0;
    $this->running = FALSE;
  }

---

The documentation for this class was generated from the following file:

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/Profiler/Timer.php