RTI Connext C# API  6.1.0
NetworkCapture Class Reference

Allows capturing the network traffic that one or more DomainParticipants send or receive into a pcap file. More...

Inherits IDisposable.

Public Member Functions

void Dispose ()
 Stop capturing traffic. More...
 
void Pause ()
 Pause capturing traffic. More...
 
void Resume ()
 Resume capturing traffic. More...
 

Static Public Member Functions

static void Enable ()
 Enable Network Capture. To enable, this function must be called before Start and before the creation of any DomainParticipant for which you want to capture traffic. More...
 
static void Disable ()
 Disable Network Capture. More...
 
static void SetDefaultParams (NetworkCaptureParams parameters)
 Set the default NetworkCaptureParams to be used when the parameters are not specified in Start(). More...
 
static NetworkCapture Start (string fileName)
 Start capturing traffic for all DomainParticipants, with the default parameters. The method Enable must be called before this. More...
 
static NetworkCapture Start (DomainParticipant participant, string fileName)
 Start capturing traffic for a DomainParticipant, with the default parameters. The method Enable must be called before this. More...
 
static NetworkCapture Start (string fileName, NetworkCaptureParams parameters)
 Start capturing traffic for all DomainParticipants, with specific parameters. The method Enable must be called before this. More...
 
static NetworkCapture Start (DomainParticipant participant, string fileName, NetworkCaptureParams parameters)
 Start capturing traffic for a DomainParticipant, with specific parameters. The method Enable must be called before this. More...
 

Detailed Description

Allows capturing the network traffic that one or more DomainParticipants send or receive into a pcap file.

The full documentation is available in the C API: NDDS_Utility

Member Function Documentation

◆ Disable()

static void Disable ( )
static

Disable Network Capture.

The full documentation is available in the C API: NDDS_Utility_disable_network_capture

◆ Dispose()

void Dispose ( )

Stop capturing traffic.

The full documentation is available in the C API: NDDS_Utility_stop_network_capture

◆ Enable()

static void Enable ( )
static

Enable Network Capture. To enable, this function must be called before Start and before the creation of any DomainParticipant for which you want to capture traffic.

The full documentation is available in the C API: NDDS_Utility_enable_network_capture

◆ Pause()

void Pause ( )

Pause capturing traffic.

The full documentation is available in the C API: NDDS_Utility_pause_network_capture

◆ Resume()

void Resume ( )

Resume capturing traffic.

The full documentation is available in the C API: NDDS_Utility_pause_network_capture

◆ SetDefaultParams()

static void SetDefaultParams ( NetworkCaptureParams  parameters)
static

Set the default NetworkCaptureParams to be used when the parameters are not specified in Start().

◆ Start() [1/4]

static NetworkCapture Start ( DomainParticipant  participant,
string  fileName 
)
static

Start capturing traffic for a DomainParticipant, with the default parameters. The method Enable must be called before this.

Returns
An object that allows pausing or stoping the capture

The full documentation is available in the C API: NDDS_Utility_start_network_capture_for_participant

◆ Start() [2/4]

static NetworkCapture Start ( DomainParticipant  participant,
string  fileName,
NetworkCaptureParams  parameters 
)
static

Start capturing traffic for a DomainParticipant, with specific parameters. The method Enable must be called before this.

Returns
An object that allows pausing or stoping the capture

The full documentation is available in the C API: NDDS_Utility_start_network_capture_for_participant

◆ Start() [3/4]

static NetworkCapture Start ( string  fileName)
static

Start capturing traffic for all DomainParticipants, with the default parameters. The method Enable must be called before this.

Returns
An object that allows pausing or stoping the capture

The full documentation is available in the C API: NDDS_Utility_start_network_capture

◆ Start() [4/4]

static NetworkCapture Start ( string  fileName,
NetworkCaptureParams  parameters 
)
static

Start capturing traffic for all DomainParticipants, with specific parameters. The method Enable must be called before this.

Returns
An object that allows pausing or stoping the capture

The full documentation is available in the C API: NDDS_Utility_start_network_capture