Heap Monitoring

Monitor memory allocations done by the middleware on the native heap. More...

Classes
class	NDDS::HeapMonitoringParams_t
	Input parameters for enabling heap monitoring. They will be used for configuring the format of the snapshot. More...
class	NDDS::HeapMonitoring
	Heap Monitoring APIs. More...

Enumerations
enum	NDDS::HeapMonitoringSnapshotOutputFormat : UINT32 {   NDDS::HeapMonitoringSnapshotOutputFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD,   NDDS::HeapMonitoringSnapshotOutputFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_COMPRESSED }
	Specify the format of the output of the snapshot. RTI Connext. More...
enum	NDDS::HeapMonitoringSnapshotContentFormat : UINT32 {   NDDS::HeapMonitoringSnapshotContentFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_TOPIC,   NDDS::HeapMonitoringSnapshotContentFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_FUNCTION,   NDDS::HeapMonitoringSnapshotContentFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_ACTIVITY,   NDDS::HeapMonitoringSnapshotContentFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_DEFAULT,   NDDS::HeapMonitoringSnapshotContentFormat::NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_MINIMAL }
	Bitmap used to decide which information of the snapshot will be displayed. More...

Detailed Description

Monitor memory allocations done by the middleware on the native heap.

RTI Connext allows you to monitor the memory allocations done by the middleware on the native heap. This feature can be used to analyze and debug unexpected memory growth.

After NDDS::HeapMonitoring::enable is called, you may invoke NDDS::HeapMonitoring::take_heap_snapshot to save the current heap memory usage to a file. By comparing two snapshots, you can tell if new memory has been allocated and, in many cases, where.

Enumeration Type Documentation

HeapMonitoringSnapshotOutputFormat

enum NDDS::HeapMonitoringSnapshotOutputFormat : UINT32

strong

Specify the format of the output of the snapshot. RTI Connext.

Enumerator
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD	The output of the snapshot will be in plain text.
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_COMPRESSED	The output of the snapshot will be compressed using Zlib techonology. The file can be uncompressed using zlib-flate.

HeapMonitoringSnapshotContentFormat

enum NDDS::HeapMonitoringSnapshotContentFormat : UINT32

strong

Bitmap used to decide which information of the snapshot will be displayed.

Enumerator
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_TOPIC	Add the topic to the snapshot of heap monitoring.
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_FUNCTION	Add the function name to the snapshot of heap monitoring.
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_ACTIVITY	Add the activity context to the snapshot of heap monitoring. The user can select the information that will be part of the activity context by using the API NDDS::ActivityContext::set_attribute_mask.
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_DEFAULT	Add all the optional attributes to the snapshot of heap monitoring.
NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_MINIMAL	Not add any optional attribute to the snapshot of heap monitoring.