NDDS_Utility_NetworkCaptureParams_t Struct Reference

Input parameters for starting network capture. More...

Data Fields
struct DDS_StringSeq	transports
	List of transports to capture. More...
NDDS_Utility_NetworkCaptureContentKindMask	dropped_content
	Exclude contents from the capture file. More...
NDDS_Utility_NetworkCaptureTrafficKindMask	traffic
	Traffic direction to capture. More...
DDS_Boolean	parse_encrypted_content
	If secure traffic should be decrypted or not. More...
struct DDS_ThreadSettings_t	checkpoint_thread_settings
	The properties of the checkpoint thread. More...
DDS_Long	frame_queue_size
	Size of the frame queue (Bytes). More...

Detailed Description

Input parameters for starting network capture.

Field Documentation

transports

struct DDS_StringSeq NDDS_Utility_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

NDDS_Utility_NetworkCaptureContentKindMask NDDS_Utility_NetworkCaptureParams_t::dropped_content

Exclude contents from the capture file.

It accepts values from NDDS_Utility_NetworkCaptureContentKind and NDDS_Utility_NetworkCaptureContentKindMask .

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

[default] No content is excluded - NDDS_UTILITY_NETWORK_CAPTURE_CONTENT_MASK_DEFAULT.

traffic

NDDS_Utility_NetworkCaptureTrafficKindMask NDDS_Utility_NetworkCaptureParams_t::traffic

Traffic direction to capture.

It accepts values from NDDS_Utility_NetworkCaptureTrafficKind and NDDS_Utility_NetworkCaptureTrafficKindMask .

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

parse_encrypted_content

DDS_Boolean NDDS_Utility_NetworkCaptureParams_t::parse_encrypted_content

If secure traffic should be decrypted or not.

Network Capture supports decryption of RTPS messages and submessages. It does not support decryption of the user data payload (<data_protection_kind> tag in the GovernanceDocument).

[default] DDS_BOOLEAN_FALSE

checkpoint_thread_settings

struct DDS_ThreadSettings_t NDDS_Utility_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 (DDS_THREAD_SETTINGS_PRIORITY_ENFORCE | DDS_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

DDS_Long NDDS_Utility_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).