RTI Connext C# API Version 7.2.0
Rti.Utility.HeapMonitor Class Reference

Utility that tracks native heap memory usage by RTI Connext DDS More...

Inherits IDisposable.

Data Structures

class  Snapshot
 Contains information about memory usage More...
 

Public Member Functions

void Dispose ()
 Disables heap memory tracking. More...
 
Snapshot TakeSnapshot ()
 Takes a snapshot More...
 
Snapshot TakeSnapshot (string filename, bool printDetails)
 Takes a snapshot and saves the details into a file More...
 
void Pause ()
 Pauses heap memory tracking More...
 
void Resume ()
 Resumes tracking after Pause. More...
 

Static Public Member Functions

static HeapMonitor Enable ()
 Enables heap memory tracking. Heap monitoring must be explicitly enabled before any other RTI Connext DDS operation. More...
 

Properties

static HeapMonitor Instance [get]
 Accesses the singleton that allows taking snapshots. Enable must be called before. More...
 

Detailed Description

Utility that tracks native heap memory usage by RTI Connext DDS

Member Function Documentation

◆ Enable()

static HeapMonitor Rti.Utility.HeapMonitor.Enable ( )
inlinestatic

Enables heap memory tracking. Heap monitoring must be explicitly enabled before any other RTI Connext DDS operation.

The full documentation is available in the C API: NDDSHeapMonitoring_enable

◆ Dispose()

void Rti.Utility.HeapMonitor.Dispose ( )
inline

Disables heap memory tracking.

The full documentation is available in the C API: NDDSHeapMonitoring_disable

◆ TakeSnapshot() [1/2]

Snapshot Rti.Utility.HeapMonitor.TakeSnapshot ( )

Takes a snapshot

Returns
An object with information about heap usage

The full documentation is available in the C API: NDDSHeapMonitoring_take_heap_snapshot

◆ TakeSnapshot() [2/2]

Snapshot Rti.Utility.HeapMonitor.TakeSnapshot ( string  filename,
bool  printDetails 
)
inline

Takes a snapshot and saves the details into a file

Returns
An object with information about heap usage

The full documentation is available in the C API: NDDSHeapMonitoring_take_heap_snapshot

◆ Pause()

void Rti.Utility.HeapMonitor.Pause ( )

Pauses heap memory tracking

The full documentation is available in the C API: NDDSHeapMonitoring_pause

◆ Resume()

void Rti.Utility.HeapMonitor.Resume ( )

Resumes tracking after Pause.

The full documentation is available in the C API: NDDSHeapMonitoring_resume

Property Documentation

◆ Instance

HeapMonitor Rti.Utility.HeapMonitor.Instance
staticget

Accesses the singleton that allows taking snapshots. Enable must be called before.