ldas-tools-al 2.6.7
Loading...
Searching...
No Matches
anonymous_namespace{MemChecker.cc}::MemChecker Class Reference

Memory garbage collector. More...

#include <MemChecker.hh>

Classes

class  Trigger
 Trigger garbage collection upon deletion. More...

Public Types

typedef void(* CleanupFunction) ()
 Type specifier for exit functions.
typedef void(* CleanupFunction) ()
 Type specifier for exit functions.

Static Public Member Functions

static void Append (CleanupFunction Function, const std::string &Name, int Ring, bool Always=false)
 Add a cleanup function to call.
static void Append (CleanupFunction Function, const std::string &Name, int Ring, bool Always=false)
 Add a cleanup function to call.
static bool IsExiting ()
 Query the exiting state of the system.
static bool IsExiting ()
 Query the exiting state of the system.
static void Info ()
 Debugger routine.
static void Info ()
 Debugger routine.

Static Private Member Functions

static void cleanup ()
 Release all resources entrusted.
static void cleanup ()
 Release all resources entrusted.
static void is_exiting (bool Value)
 Set the exit status for other to query.
static void is_exiting (bool Value)
 Set the exit status for other to query.

Friends

class Trigger

Detailed Description

Memory garbage collector.

This class keeps track of user defined cleanup routines to be called.

Todo
Put in code snippet

This class keeps track of user defined cleanup routines to be called.

Todo
Put in code snippet

Member Typedef Documentation

◆ CleanupFunction [1/2]

typedef void(* LDASTools::AL::MemChecker::CleanupFunction) ()

Type specifier for exit functions.

◆ CleanupFunction [2/2]

typedef void(* LDASTools::AL::MemChecker::CleanupFunction) ()

Type specifier for exit functions.

Member Function Documentation

◆ Append() [1/2]

void LDASTools::AL::MemChecker::Append ( MemChecker::CleanupFunction Function,
const std::string & Name,
int Ring,
bool Always = false )
static

Add a cleanup function to call.

Parameters
[in]FunctionThe function to be called
[in]NameA descriptive name of the action being taken
[in]RingThe level at which to call. The ring structure is inverted in that rings of higher value are called prior to rings of lesser values.
Note
On systems that support cleaning of the memory prior to exit, setting the environment variable 'MEMCHECK_GARBAGE_COLLECTION' prevents the system from registering cleanup helpers.

◆ Append() [2/2]

void LDASTools::AL::MemChecker::Append ( CleanupFunction Function,
const std::string & Name,
int Ring,
bool Always = false )
static

Add a cleanup function to call.

Parameters
[in]FunctionThe function to be called
[in]NameA descriptive name of the action being taken
[in]RingThe level at which to call. The ring structure is inverted in that rings of higher value are called prior to rings of lesser values.

◆ cleanup() [1/2]

void LDASTools::AL::MemChecker::cleanup ( )
staticprivate

Release all resources entrusted.

◆ cleanup() [2/2]

void LDASTools::AL::MemChecker::cleanup ( )
staticprivate

Release all resources entrusted.

◆ Info() [1/2]

void LDASTools::AL::MemChecker::Info ( )
static

Debugger routine.

◆ Info() [2/2]

void LDASTools::AL::MemChecker::Info ( )
static

Debugger routine.

◆ is_exiting() [1/2]

void LDASTools::AL::MemChecker::is_exiting ( bool Value)
staticprivate

Set the exit status for other to query.

Parameters
[in]ValueNew value for exiting status.

◆ is_exiting() [2/2]

void LDASTools::AL::MemChecker::is_exiting ( bool Value)
staticprivate

Set the exit status for other to query.

Parameters
[in]ValueNew value for exiting status.

◆ IsExiting() [1/2]

bool LDASTools::AL::MemChecker::IsExiting ( )
static

Query the exiting state of the system.

◆ IsExiting() [2/2]

bool LDASTools::AL::MemChecker::IsExiting ( )
static

Query the exiting state of the system.

◆ Trigger

Trigger
friend

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/MemChecker.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/MemChecker.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/MemChecker.cc