GemaCoreLib
The GeMA Core library
Classes | Macros | Enumerations
gmMemoryDump.h File Reference

Declaration of the GmMemoryDump and GmMemoryDumpItem classes. More...

#include "gmCoreConfig.h"
#include "gmLog.h"
#include <QString>
#include <QVector>
#include <QByteArray>
Include dependency graph for gmMemoryDump.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  GmMemoryBufferList
 A helper class that can store a list of buffers and their sizes, allowing for GmMemoryDumpItem instances to return multi part buffers from getDataBuffer() and setDataBuffer() More...
 
class  GmMemoryDumpItem
 Interface for an object that can be dumped and undumped to either file or memory by GmMemoryDump. More...
 
class  GmMemoryDump
 Class storing a memory dump containing several dump items. More...
 
struct  GmMemoryDump::FileControlHeader
 The file structure with file control info. More...
 
struct  GmMemoryDump::FileDataChunkHeader
 The file header for each data chunk. More...
 
struct  GmMemoryDump::FileInfoBlockHeader
 The structure storing control info for an Info block. More...
 
struct  GmMemoryDump::FileItemHeader
 The file header for every data item. More...
 
struct  GmMemoryDump::ItemHeader
 The in memory control header for every data item. More...
 
struct  GmMemoryDump::DumpItem
 The structure adding controll information to a GmMemoryDumpItem. More...
 

Macros

#define GM_MEMORY_DUMP_ITEM_NAME_SIZE   80
 The maximum size for a dump item name.
 
#define GM_MEMORY_DUMP_ITEM_DATA_SIZE   16
 The size of the per item fixed item data buffer.
 
#define GM_MEMORY_DUMP_MIN_COMPRESSION   (4 * 1024)
 The default minimum buffer size in bytes for compression to be worthy (must be > 0)
 

Enumerations

enum  GmMemoryDumpMode { GM_DUMP_AUTO, GM_DUMP_MEMORY, GM_DUMP_FILE, GM_DUMP_RESTORE }
 Supported memory dump modes. More...
 

Detailed Description

Declaration of the GmMemoryDump and GmMemoryDumpItem classes.

Author
Carlos A. T. Mendes
Date
july, 2020

Enumeration Type Documentation

◆ GmMemoryDumpMode

Supported memory dump modes.

Enumerator
GM_DUMP_AUTO 

Auto mode. Dumped memory is saved either on file or on memory depending on memory usage.

GM_DUMP_MEMORY 

Dumped memory is saved on memory.

GM_DUMP_FILE 

Dumped memory is saved to a file.

GM_DUMP_RESTORE 

Dumped file is opend for restore only. No save operations are allowed.