RTI Connext C# API  7.1.0
NetworkCaptureParams Class Reference

Configures the options of a NetworkCapture. More...

Inherits IEquatable< NetworkCaptureParams >.

Public Types

enum class  TrafficKind {
  None ,
  Out ,
  In ,
  Default ,
  All
}
 Indicates the traffic direction in Traffic More...
 
enum class  ContentKind {
  None ,
  Default ,
  User ,
  Encrypted ,
  All
}
 Indicates the kind of content in DroppedContent More...
 

Public Member Functions

 NetworkCaptureParams ()
 Creates a new instance with the default parameters More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (NetworkCaptureParams other)
 Compares for equality More...
 

Properties

IList< string > Transports [get, set]
 List of transports to capture More...
 
ContentKind DroppedContent [get, set]
 Exclude contents from the capture file. More...
 
TrafficKind Traffic [get, set]
 Traffic direction to capture More...
 
bool ParseEncryptedContent [get, set]
 If secure traffic should be decrypted or not. More...
 
ThreadSettings CheckpointThreadSettings [get, set]
 The properties of the checkpoint thread. More...
 
int FrameQueueSize [get, set]
 Size of the frame queue (Bytes). More...
 

Detailed Description

Configures the options of a NetworkCapture.

Member Enumeration Documentation

◆ ContentKind

enum ContentKind
strong

Indicates the kind of content in DroppedContent

Enumerator
None 

None

Default 

Default configuration (None)

User 

User content

Encrypted 

Encrypted content

All 

All content

◆ TrafficKind

enum TrafficKind
strong

Indicates the traffic direction in Traffic

Enumerator
None 

None

Out 

Output traffic

In 

Input traffic

Default 

Default configuration (All)

All 

Input and output traffic

Constructor & Destructor Documentation

◆ NetworkCaptureParams()

Creates a new instance with the default parameters

Member Function Documentation

◆ Equals() [1/2]

bool Equals ( NetworkCaptureParams  other)

Compares for equality

◆ Equals() [2/2]

override bool Equals ( object  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

Property Documentation

◆ CheckpointThreadSettings

ThreadSettings CheckpointThreadSettings
getset

The properties of the checkpoint thread.

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::checkpoint_thread_settings

◆ DroppedContent

ContentKind DroppedContent
getset

Exclude contents from the capture file.

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::dropped_content

◆ FrameQueueSize

int FrameQueueSize
getset

Size of the frame queue (Bytes).

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::frame_queue_size

◆ ParseEncryptedContent

bool ParseEncryptedContent
getset

If secure traffic should be decrypted or not.

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::parse_encrypted_content

◆ Traffic

TrafficKind Traffic
getset

Traffic direction to capture

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::traffic

◆ Transports

IList<string> Transports
getset

List of transports to capture

The full documentation is available in the C API: NDDS_Utility_NetworkCaptureParams_t::transports