cookmem::MemLogger Class Reference

#include <logger.h>

Public Member Functions
virtual void	logGetSegment (void *segment, std::size_t segmentSize)=0
virtual void	logFreeSegment (void *segment, std::size_t segmentSize)=0
virtual void	logTrimEmptySegments ()=0
virtual void	logAllocation (void *userPtr, std::size_t userSize, MemAllocType_et allocType)=0
virtual void	logReallocation (void *userPtr, std::size_t oldUserSize, std::size_t newUserSize)=0
virtual void	logDeallocation (void *userPtr, std::size_t userSize)=0
virtual void	logError (void *userPtr, MemError_et error, const char *file=__FILE__, int line=__LINE__)=0

Detailed Description

A MemLogger logs memory allocation, deallocation, and errors.

This class here is merely used to define the functions needed to implement a MemLogger.

Member Function Documentation

logAllocation()

virtual void cookmem::MemLogger::logAllocation ( void *  userPtr, std::size_t  userSize, MemAllocType_et  allocType  )

pure virtual

Log the memory allocation.

Parameters

userPtr	the user pointer allocated.
userSize	the user requested size.
allocType	the type of the allocation.

logDeallocation()

virtual void cookmem::MemLogger::logDeallocation ( void *  userPtr, std::size_t  userSize  )

pure virtual

Log the memory deallocation.

Parameters

userPtr	the user pointer allocated.
userSize	the user requested size.

logError()

virtual void cookmem::MemLogger::logError ( void *  userPtr, MemError_et  error, const char *  file = __FILE__, int  line = __LINE__  )

pure virtual

Log the memory corruption.

Parameters

userPtr	the user pointer that had the memory corruption.
error	the type of the error encountered.
file	the source file where the error was detected.
line	the line number where the error was detected.

logFreeSegment()

virtual void cookmem::MemLogger::logFreeSegment ( void *  segment, std::size_t  segmentSize  )

pure virtual

Log the memory segment release.

Parameters

segment	the segment released.
segmentSize	the segment size.

logGetSegment()

virtual void cookmem::MemLogger::logGetSegment ( void *  segment, std::size_t  segmentSize  )

pure virtual

Log the memory segment allocation.

Parameters

segment	the segment obtained.
segmentSize	the segment size.

logReallocation()

virtual void cookmem::MemLogger::logReallocation ( void *  userPtr, std::size_t  oldUserSize, std::size_t  newUserSize  )

pure virtual

Log the memory reallocation. This is only called when the new size is smaller than the original size.

Parameters

userPtr	the user pointer allocated.
oldUserSize	the old user size.
newUserSize	the new user size.

logTrimEmptySegments()

virtual void cookmem::MemLogger::logTrimEmptySegments ( )

pure virtual

Log a pool empty-segment trimming pass.

---

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

• logger.h