NDDS::NetworkCaptureParams_t Class Reference

Input parameters for starting network capture. More...

#include <managed_domain.h>

Public Attributes
DDS::StringSeq ^	transports
	List of transports to capture. More...
NetworkCaptureContentKind	dropped_content
	Exclude contents from the capture file. More...
NetworkCaptureTrafficKind	traffic
	Traffic direction to capture. More...
System::Boolean	parse_encrypted_content
	If secure traffic should be decrypted or not. More...
ThreadSettings_t ^	checkpoint_thread_settings
	The properties of the checkpoint thread. More...
System::Int32	frame_queue_size
	Size of the frame queue (Bytes). More...

Detailed Description

Input parameters for starting network capture.

Member Data Documentation

transports

DDS::StringSeq ^ NDDS::NetworkCaptureParams_t::transports

List of transports to capture.

Network Capture will only save RTPS frames if the associated transport protocol is part of this sequence.

[default] Empty sequence initializer. This means that by default all transports will be captured.

dropped_content

NetworkCaptureContentKind NDDS::NetworkCaptureParams_t::dropped_content

Exclude contents from the capture file.

It accepts values from NDDS::NetworkCaptureContentKind .

We can choose to exclude user data or encrypted content from the capture file.

[default] No content is excluded - MASK_DEFAULT.

traffic

NetworkCaptureTrafficKind NDDS::NetworkCaptureParams_t::traffic

Traffic direction to capture.

It accepts values from NDDS::NetworkCaptureTrafficKind .

[default] Capture both inbound and outbound traffic - MASK_DEFAULT.

parse_encrypted_content

System::Boolean NDDS::NetworkCaptureParams_t::parse_encrypted_content

If secure traffic should be decrypted or not.

[default] false

checkpoint_thread_settings

ThreadSettings_t ^ NDDS::NetworkCaptureParams_t::checkpoint_thread_settings

The properties of the checkpoint thread.

The checkpoint thread is a per-participant thread responsible for reading frames from a queue and saving them to disk (as soon as they are produced).

The members that can be configured are:

• DDS::ThreadSettings_t::mask. Default value of (THREAD_SETTINGS_PRIORITY_ENFORCE | THREAD_SETTINGS_STDIO).
• DDS::ThreadSettings_t::priority. Platform-dependent - Consult Platform Notes for additional details.
• DDS::ThreadSettings_t::stack_size. Platform-dependent - Consult Platform Notes for additional details.

frame_queue_size

System::Int32 NDDS::NetworkCaptureParams_t::frame_queue_size

Size of the frame queue (Bytes).

Network capture enqueues frames before saving them to disk, which takes place in a separate thread.

Network Capture does not block if the queue becomes full. Attempting to enqueue a frame with a full frame queue will fail (frame won't be captured) with a log message.

The size of the queue is dependent on the network traffic (amount of frames that we want to capture) and system resources (how fast we can capture frames).

[default] 2097152 (2MB).