HeapMonitoringParams Class Reference

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

Inherits Struct.

Public Attributes
HeapMonitoringSnapshotOutputFormat	snapshot_output_format
	Specify the format of the output of the snapshot. More...
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.

Member Data Documentation

snapshot_output_format

HeapMonitoringSnapshotOutputFormat snapshot_output_format

Initial value:

=
        HeapMonitoringSnapshotOutputFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD

Specify the format of the output of the snapshot.

The enum can take two options:

• com.rti.ndds.utility.HeapMonitoringSnapshotOutputFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD:
  The output of the snapshot will be in plain text.
  
• com.rti.ndds.utility.HeapMonitoringSnapshotOutputFormat.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] com.rti.ndds.utility.HeapMonitoringSnapshotOutputFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_OUTPUT_FORMAT_STANDARD.

snapshot_content_format

HeapMonitoringSnapshotContentFormat snapshot_content_format

Initial value:

=
        HeapMonitoringSnapshotContentFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_DEFAULT

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: (com.rti.ndds.utility.HeapMonitoringSnapshotContentFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_TOPIC | com.rti.ndds.utility.HeapMonitoringSnapshotContentFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_BIT_FUNCTION)

[default] com.rti.ndds.utility.HeapMonitoringSnapshotContentFormat.NDDS_UTILITY_HEAP_MONITORING_SNAPSHOT_CONTENT_DEFAULT