rti::util::network_capture::NetworkCaptureParams Class Reference

<<extension>> Input parameters for starting Network Capture. More...

#include <network_capture.hpp>

Inherits rti::core::NativeValueType< T, NATIVE_T, ADAPTER >.

Public Member Functions
dds::core::StringSeq	transports () const
	Get the list of transports to capture. More...
NetworkCaptureParams &	transports (const dds::core::StringSeq &transports_in)
	Set the list of transports to capture. More...
ContentKindMask	dropped_content () const
	Get the type of contents to exclude from the capture file. More...
NetworkCaptureParams &	dropped_content (ContentKindMask dropped_content_in)
	Set the type of contents to exclude from the capture file. More...
TrafficKindMask	traffic () const
	Get the traffic direction to capture. More...
NetworkCaptureParams &	traffic (TrafficKindMask traffic_in)
	Set the traffic direction to capture. More...
bool	parse_encrypted_content () const
	Get whether Network Capture will parse encrypted contents. More...
NetworkCaptureParams &	parse_encrypted_content (bool parse_encrypted_content_in)
	Set whether Network Capture will parse encrypted contents. More...
const rti::core::ThreadSettings &	checkpoint_thread_settings () const
	Get the properties of the checkpoint thread. More...
NetworkCaptureParams &	checkpoint_thread_settings (const rti::core::ThreadSettings &checkpoint_thread_settings_in)
	Set the properties of the checkpoint thread. More...
int32_t	frame_queue_size () const
	Get the size of the frame queue (Bytes). More...
NetworkCaptureParams &	frame_queue_size (int32_t frame_queue_size_in)
	Set the size of the frame queue. More...

Detailed Description

<<extension>> Input parameters for starting Network Capture.

Member Function Documentation

transports() [1/2]

dds::core::StringSeq rti::util::network_capture::NetworkCaptureParams::transports

(

)

const

Get the list of transports to capture.

Returns

List of transports to capture.

transports() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::transports

(

const dds::core::StringSeq &

transports_in

)

Set the 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.

Parameters

transports_in

The sequence of transports that we want to capture traffic from.

Returns

The Network Capture's parameter instance.

dropped_content() [1/2]

ContentKindMask rti::util::network_capture::NetworkCaptureParams::dropped_content

(

)

const

Get the type of contents to exclude from the capture file.

Returns

Contents to exclude from the capture file.

dropped_content() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::dropped_content

(

ContentKindMask

dropped_content_in

)

Set the type of contents to exclude from the capture file.

It accepts values from network_capture::ContentKindMask .

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

[default] No content is excluded - network_capture::ContentKindMask::default_mask().

Parameters

dropped_content_in

The mask of contents to exclude from the capture.

Returns

The Network Capture's parameter instance.

traffic() [1/2]

TrafficKindMask rti::util::network_capture::NetworkCaptureParams::traffic

(

)

const

Get the traffic direction to capture.

Returns

Traffic direction to capture.

traffic() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::traffic

(

TrafficKindMask

traffic_in

)

Set the traffic direction to capture.

It accepts values from network_capture::TrafficKindMask .

[default] Capture both inbound and outbound traffic - network_capture::TrafficKindMask::default_mask().

Parameters

traffic_in

The mask with the traffic directions that we want to capture.

Returns

The Network Capture's parameter instance.

parse_encrypted_content() [1/2]

bool rti::util::network_capture::NetworkCaptureParams::parse_encrypted_content

(

)

const

Get whether Network Capture will parse encrypted contents.

Returns

Whether Network Capture will parse encrypted contents.

parse_encrypted_content() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::parse_encrypted_content

(

bool

parse_encrypted_content_in

)

Set whether Network Capture will parse encrypted contents.

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] false

Parameters

parse_encrypted_content_in

Boolean indicating whether to parse or not encrypted content.

Returns

The Network Capture's parameter instance.

checkpoint_thread_settings() [1/2]

const rti::core::ThreadSettings & rti::util::network_capture::NetworkCaptureParams::checkpoint_thread_settings

(

)

const

Get the properties of the checkpoint thread.

Returns

Properties of the checkpoint thread.

checkpoint_thread_settings() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::checkpoint_thread_settings

(

const rti::core::ThreadSettings &

checkpoint_thread_settings_in

)

Set 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:

• rti::core::ThreadSettings::mask. Default value of (rti::core::ThreadSettingsKindMask::THREAD_SETTINGS_PRIORITY_ENFORCE | rti::core::ThreadSettingsKindMask::stdio()).
• rti::core::ThreadSettings::priority. Platform-dependent - Consult Platform Notes for additional details.
• rti::core::ThreadSettings::stack_size. Platform-dependent - Consult Platform Notes for additional details.

Parameters

checkpoint_thread_settings_in

Properties of the checkpoint thread that we want to set.

Returns

The Network Capture's parameter instance.

frame_queue_size() [1/2]

int32_t rti::util::network_capture::NetworkCaptureParams::frame_queue_size

(

)

const

Get the 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).

Returns

Size of the frame queue (Bytes).

frame_queue_size() [2/2]

NetworkCaptureParams & rti::util::network_capture::NetworkCaptureParams::frame_queue_size

(

int32_t

frame_queue_size_in

)

Set the size of the frame queue.

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

Parameters

frame_queue_size_in

Size of the frame queue in Bytes.

Returns

The Network Capture's parameter instance.