EHS
ehs::GC Class Reference

#include <GC.h>

Static Public Member Functions

static void Start ()
 
static void Stop ()
 
static bool HasLogic (GcLogic logicCb)
 
static bool AddLogic (GcLogic logicCb)
 
static void Add (BaseObj *obj)
 
static void SetMax (UInt_64 newMax)
 
static UInt_64 GetMax ()
 
static void SetStride (UInt_64 newStride)
 
static UInt_64 GetStride ()
 
static UInt_64 Size ()
 
static void Poll ()
 Used to delete objects over time. More...
 
static void Dump ()
 
static bool IsRunning ()
 

Member Function Documentation

◆ Add()

void ehs::GC::Add ( BaseObj obj)
static

Adds an object to the garbage pile to be deleted.

Parameters
[in]objThe object to be deleted.

◆ AddLogic()

bool ehs::GC::AddLogic ( GcLogic  logicCb)
static

◆ Dump()

void ehs::GC::Dump ( )
static

Deletes all of the data at once.

Warning
Use Poll instead to prevent stutter.

◆ GetMax()

UInt_64 ehs::GC::GetMax ( )
static

Gets the maximum amount of garbage to delete per poll.

Returns
The maximum.

◆ GetStride()

UInt_64 ehs::GC::GetStride ( )
static

The amount of data pre-allocated to save on memory operations.

Returns
The stride.

◆ HasLogic()

bool ehs::GC::HasLogic ( GcLogic  logicCb)
static

◆ IsRunning()

bool ehs::GC::IsRunning ( )
static

◆ Poll()

void ehs::GC::Poll ( )
static

Used to delete objects over time.

◆ SetMax()

void ehs::GC::SetMax ( UInt_64  newMax)
static

Sets the maximum amount of garbage to delete per poll.

Parameters
[in]newMaxThe new maximum.

◆ SetStride()

void ehs::GC::SetStride ( UInt_64  newStride)
static

Sets a new amount for memory pre-allocation to save on memory operations.

Parameters
[in]newStrideThe stride to pre-allocate.

◆ Size()

UInt_64 ehs::GC::Size ( )
static

Gets the garbage count.

Returns
Garbage count.

◆ Start()

void ehs::GC::Start ( )
static

◆ Stop()

void ehs::GC::Stop ( )
static

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