LowMemoryEvent Class Reference

Public Member Functions
	__construct ($memory, $memoryLimit, $isGlobal=false, $triggerCount=0)
	getMemory ()
	getMemoryLimit ()
	getTriggerCount ()
	isGlobal ()
	getMemoryFreed ()
Public Member Functions inherited from Event
	getEventName ()
	getHandlers ()

Static Public Attributes
static	$handlerList = null

Additional Inherited Members
Protected Attributes inherited from Event
	$eventName = null

Detailed Description

Called when the server is in a low-memory state as defined by the properties Plugins should free caches or other non-essential data.

Constructor & Destructor Documentation

__construct()

__construct	(		$memory,
			$memoryLimit,
			$isGlobal = false,
			$triggerCount = 0
	)

LowMemoryEvent constructor.

Parameters

	$memory
	$memoryLimit
bool	$isGlobal
int	$triggerCount

                                                                                            {
        $this->memory = $memory;
        $this->memoryLimit = $memoryLimit;
        $this->global = (bool) $isGlobal;
        $this->triggerCount = (int) $triggerCount;
    }

Member Function Documentation

getMemory()

getMemory

(

)

Returns the memory usage at the time of the event call (in bytes)

Returns

int

                               {
        return $this->memory;
    }

getMemoryFreed()

getMemoryFreed

(

)

Amount of memory already freed

Returns

int

                                    {
        return $this->getMemory() - ($this->isGlobal() ? Utils::getMemoryUsage(true)[1] : Utils::getMemoryUsage(true)[0]);
    }

getMemoryLimit()

getMemoryLimit

(

)

Returns the memory limit defined (in bytes)

Returns

int

                                    {
        return $this->memory;
    }

getTriggerCount()

getTriggerCount

(

)

Returns the times this event has been called in the current low-memory state

Returns

int

                                     {
        return $this->triggerCount;
    }

isGlobal()

isGlobal

(

)

Returns

bool

                              {
        return $this->global;
    }

Field Documentation

$handlerList

$handlerList = null

static

---

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

• src/pocketmine/event/server/LowMemoryEvent.php