MbGarbageCollection Class Reference

Garbage collector in objects which use data caching. More...

#include <tool_multithreading.h>

Static Public Member Functions
static void	Subscribe (CacheCleaner *obj)
	Subscribe the object for garbage collection.
static void	Unsubscribe (CacheCleaner *obj)
	Unsubscribe the object from garbage collection.
static bool	Run (bool force=false)
	Perform garbage collection. More...
static void	Reset ()
	Reset all registered caches. More...
static void	Enable (bool allow=true)
	Enable/disable collecting data for garbage collection. By default, collecting data for garbage collection is enabled.

Detailed Description

Garbage collector in objects which use data caching.

Garbage collector. At request clears caches in registered CacheCleaner objects by calling the method ResetCacheData of each object.

Member Function Documentation

Run()

static bool MbGarbageCollection::Run ( bool  force = false )

static

Perform garbage collection.

The function should be called in sequential code. When called in a parallel region, does nothing. Calls method ResetCacheData of each object.

Parameters

[in]

force

- If false, then run garbage collection in caches created for threads which are finished, if true, then force garbage collection in all caches.

Returns

Returns TRUE if the garbage collection is done.

Reset()

static void MbGarbageCollection::Reset ( )

static

Reset all registered caches.

Reset all registered caches after fatal error. Should be called in sequential code. When called in a parallel region, does nothing. Calls method HardReset of each object.

---

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

• tool_multithreading.h