ldas-tools-al  2.6.5
Classes | Public Types | Static Public Member Functions | Static Private Member Functions | Friends | List of all members
LDASTools::AL::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. More...
 
typedef void(* CleanupFunction) ()
 Type specifier for exit functions. More...
 
typedef void(* CleanupFunction) ()
 Type specifier for exit functions. More...
 

Static Public Member Functions

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

Static Private Member Functions

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

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

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

Todo:
Put in code snippet

Member Typedef Documentation

◆ CleanupFunction [1/3]

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

Type specifier for exit functions.

◆ CleanupFunction [2/3]

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

Type specifier for exit functions.

◆ CleanupFunction [3/3]

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

Type specifier for exit functions.

Member Function Documentation

◆ Append() [1/3]

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/3]

static 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.

◆ Append() [3/3]

static 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/3]

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

Release all resources entrusted.

◆ cleanup() [2/3]

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

Release all resources entrusted.

◆ cleanup() [3/3]

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

Release all resources entrusted.

◆ Info() [1/3]

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

Debugger routine.

◆ Info() [2/3]

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

Debugger routine.

◆ Info() [3/3]

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

Debugger routine.

◆ is_exiting() [1/3]

static 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/3]

static 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() [3/3]

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/3]

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

Query the exiting state of the system.

◆ IsExiting() [2/3]

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

Query the exiting state of the system.

◆ IsExiting() [3/3]

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

Query the exiting state of the system.

Friends And Related Function Documentation

◆ Trigger

Trigger
friend

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