Unsupported Utilities

Unsupported APIs used by examples in the RTI Connext distribution as well as in rtiddsgen-generated examples. More...

Functions
void	rti::util::sleep (const dds::core::Duration &durationIn)
	Block the calling thread for the specified duration.
bool	rti::util::heap_monitoring::enable ()
	Starts monitoring the heap memory used by RTI Connext.
void	rti::util::heap_monitoring::disable ()
	Stops monitoring the heap memory used by RTI Connext.
bool	rti::util::heap_monitoring::pause ()
	Pauses heap monitoring.
bool	rti::util::heap_monitoring::resume ()
	Resumes heap monitoring.
bool	rti::util::heap_monitoring::take_snapshot (const std::string &filename, bool print_details=false)
	Saves the current heap memory usage in a file.

Detailed Description

Unsupported APIs used by examples in the RTI Connext distribution as well as in rtiddsgen-generated examples.

Function Documentation

void rti::util::sleep

(

const dds::core::Duration &

durationIn

)

Block the calling thread for the specified duration.

Note that the achievable resolution of sleep is OS-dependent. That is, do not assume that you can sleep for 1 nanosecond just because you can specify a 1-nanosecond sleep duration via the API. The sleep resolution on most operating systems is usually 10 ms or greater.

Parameters

durationIn

<<in>> Sleep duration.

MT Safety:

safe

Examples:

Foo_publisher.cxx.

bool rti::util::heap_monitoring::enable

(

)

Starts monitoring the heap memory used by RTI Connext.

This function must be called before any other function in the RTI Connext library is called.

Once heap monitoring is enabled, you can take heap snapshots by using rti::util::heap::take_snapshot().

Use this method only for debugging purposes, as it may introduce a significant performance impact.

MT Safety:

UNSAFE. It is not safe to call this method while another thread may be simultaneously calling another heap-related method, including this one.

Returns

true if success. Otherwise, false

See Also

rti::util::heap::disable()

void rti::util::heap_monitoring::disable

(

)

Stops monitoring the heap memory used by RTI Connext.

This method must be the last method called from RTI Connext.

See Also

rti::util::heap::enable()

bool rti::util::heap_monitoring::pause

(

)

Pauses heap monitoring.

New memory allocations will not be monitored and they will not appear in the snapshot generated by rti::util::heap::take_snapshot().

Returns

true if success. Otherwise, false

See Also

rti::util::heap::resume()

bool rti::util::heap_monitoring::resume

(

)

Resumes heap monitoring.

Returns

true if success. Otherwise, false

See Also

rti::util::heap::pause()

bool rti::util::heap_monitoring::take_snapshot	(	const std::string &	filename,
		bool	print_details = false
	)

Saves the current heap memory usage in a file.

After rti::util::heap::enable() is called, you may invoke this method periodically 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. This is why this operation can be used to debug unexpected memory growth.

The format of a snapshot is as follows:

First, there is a memory usage summary like this:

Process virtual memory: 2552352768
Process physical memory: 16187392
Current heap usage: 10532131
High watermark: 10532131
Alloc count: 17634
Free count: 3518

• Process virtual memory: The amount of virtual memory in bytes taken by the process. This memory includes RTI Connext and not RTI Connext memory.
• Process virtual memory: The amount of physical memory in bytes taken by the process.
• Current heap usage: The amount of heap memory in bytes used by the middleware. For Java and .NET APIs, this memory only accounts for unmanaged RTI Connext memory, not memory living in the managed heap.
• High watermark: The maximum amount of heap usage by RTI Connext since rti::util::heap::enable() was invoked.
• Alloc count: The number of invocations to malloc, realloc, or calloc operations done by RTI Connext.
• Free count: The number of invocations to the free operation done by RTI Connext.

After the previous summary, and only if you set the parameter print_details to true, the method will print the details of every single outstanding heap allocation done by RTI Connext. For example:

block_id, timestamp, block_size, pool_alloc, pool_buffer_size, pool_buffer_count, topic_name, activity, alloc_method_name, type_name

12830, 1492838970, 104, MALLOC, 0, 0, PRESServiceRequest, PRESCstReaderCollator_new, RTIOsapiHeap_allocateStructure, struct REDAFastBufferPool

• block_id: Block ID of the allocation. This number increases with every allocation.
• timestamp: Timestamp in UTC seconds corresponding to the time where the allocation was done.
• block_size: The number of bytes allocated.
• pool_alloc: Indicates if the heap allocation is a RTI Connext pool allocation (POOL) or a regular allocation (MALLOC).
• pool_buffer_size: For pool allocations, this number indicates the size of the elements in the pool in number of bytes. block_size is equal to (pool_buffer_size * pool_buffer_count).
• pool_buffer_count: For pool allocations, this number indicates the number of buffers allocated for the pool. block_size is equal to (pool_buffer_size * pool_buffer_count).
• topic_name: The topic name associated with the allocation or 'n/a' if it is not available.
• activity: Activity associated with the allocation or 'n/a' if it is not available.
• alloc_method_name: The allocation RTI Connext method name.
• type_name: The allocation typename.

Parameters

filename	<<in>>. Name of file in which to store the snapshot.
print_details	<<in>>. Indicates if the snapshot will contain only the memory usage summary or the details of the individual allocations.

Returns

true if success. Otherwise, false