NDDS_Utility_HeapMonitoringParams_t Struct Reference

Input parameters for enabling heap monitoring. They will be used for configuring the format of the snapshot. More...

Data Fields
NDDS_Utility_HeapMonitoringSnapshotOutputFormat	snapshot_output_format
	Specify the format of the output of the snapshot. More...
NDDS_Utility_HeapMonitoringSnapshotContentFormat	snapshot_content_format
	It is a bitmap to decide which information of the snapshot will be displayed. More...

Detailed Description

Input parameters for enabling heap monitoring. They will be used for configuring the format of the snapshot.

Field Documentation

snapshot_output_format

NDDS_Utility_HeapMonitoringSnapshotOutputFormat NDDS_Utility_HeapMonitoringParams_t::snapshot_output_format

Specify the format of the output of the snapshot.

The enum can take two options:

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

[default] NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD.

snapshot_content_format

NDDS_Utility_HeapMonitoringSnapshotContentFormat NDDS_Utility_HeapMonitoringParams_t::snapshot_content_format

It is a bitmap to decide which information of the snapshot will be displayed.

```suggestion Bitmap that specifies the field to display in the snapshot.

You can combine these values by logically ORing them together. For example: (NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_TOPIC | NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_FUNCTION)

[default] NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_DEFAULT