Cpl::Memory::New_TS Class Reference

This class provides methods to access the unit testing support for overriding the global new/delete operators. More...

Detailed Description

This class provides methods to access the unit testing support for overriding the global new/delete operators.

The main purpose is to be able to trigger memory allocation failures. It also provides limited memory leak detection.

NOTE: THIS INTERFACE IS NOT THREAD SAFE!!

#include <New_TS.h>

Classes
struct	Stats
	New/Delete metrics. More...

Static Public Member Functions
static void	disable (void)
	This method will cause the next call(s) to 'new' to return a null pointer.
static void	enable (void)
	This method 'undos' the disable() call, i.e.
static void	setNewDelete_delta (long delta, bool ignoreDelta=false)
	This method is used to set the 'expected' delta between the number of calls to new and delete.
static void	getStats (Stats &stats, bool resetStats=true)
	This method returns and optionally clears the metrics collected with respect to Test heap.
static void	clearStats ()
	This method unconditionally clears the stats.

---

Class Documentation

Cpl::Memory::New_TS::Stats

struct Cpl::Memory::New_TS::Stats

New/Delete metrics.

Class Members
size_t	m_bytesAllocated
unsigned long	m_numDeleteCalls
unsigned long	m_numDeleteCalls_withNullPtr
unsigned long	m_numNewCalls
unsigned long	m_numNewCallsFailed

Member Function Documentation

clearStats()

static void Cpl::Memory::New_TS::clearStats ( )

static

This method unconditionally clears the stats.

disable()

static void Cpl::Memory::New_TS::disable ( void  )

static

This method will cause the next call(s) to 'new' to return a null pointer.

enable()

static void Cpl::Memory::New_TS::enable ( void  )

static

This method 'undos' the disable() call, i.e.

the next call(s) to new will succeed (assuming there is actual heap memory available). This is the default/startup state of the Test heap.

getStats()

static void Cpl::Memory::New_TS::getStats ( Stats &  stats, bool  resetStats = true  )

static

This method returns and optionally clears the metrics collected with respect to Test heap.

The caller is responsible for providing the memory for the returned metrics.

setNewDelete_delta()

static void Cpl::Memory::New_TS::setNewDelete_delta ( long  delta, bool  ignoreDelta = false  )

static

This method is used to set the 'expected' delta between the number of calls to new and delete.

The default is a delta of zero, i.e. a delete call for every new call.

---

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

• Cpl/Memory/_testsupport/New_TS.h