A structure that holds all the test settings for a connection as set from the command line. More...

#include <test_args.h>

Data Fields
const char *	local_adapter_ip_str
	The local network adapter IP address.

const char *	bind_ip_addr_str
	IP address to bind to.

int	dest_port
	The destination port number.

const char *	remote_adapter_ip_str
	The remote network adapter IP address.

int	num_transactions
	The number of transactions in the test.

int	tx_timeout
	The transmit timeout in microseconds for a Tx payload.

bool	use_efa
	Whether to use EFA adapter.

bool	show_ndi_sources
	Show NDI sources and stop.

bool	ndi_rx
	Enable NDI receiver.

bool	ndi_tx
	Enable NDI transmitter.

int	video_stream_id
	CDI video stream ID.

int	audio_stream_id
	CDI audio stream ID.

int	anc_data_stream_id
	CDI ancilllary data stream ID.

const char *	ndi_source_name
	The NDI source name.

const char *	ndi_source_ip
	The NDI source IP address.

const char *	ndi_source_url
	The NDI source URL address.

bool	use_ndi_timestamps
	Use NDI timestamps for CDI output instead of internally generating them.

bool	log_timestamps
	Output timestamp information to console.

bool	tx
	When true, Tx mode is enabled.

bool	rx
	When true, Rx mode is enabled.

char	connection_name_str [CDI_MAX_CONNECTION_NAME_STRING_LENGTH]
	String defining the connection name assigned to this connection.

CdiConnectionProtocolType	connection_protocol
	Enum representing the connection protocol type.

bool	keep_alive
	When true, receiver stays alive even after the first test finishes.

CdiBufferType	buffer_type
	Enum representing the buffer type.

int	rate_numerator
	The numerator for the number of payloads per second to send during the test.

int	rate_denominator
	The denominator for the number of payloads per second to send during the test.

int	rx_buffer_delay_ms
	The receive buffer delay in milliseconds for a rx payload.

bool	arg_error

uint32_t	rate_period_microseconds
	The number of microseconds in the selected frame rate.

int	shared_thread_id

int	thread_core_num
	The 0-based packet poll thread's CPU core number; -1 disables pinning to a specific core.

int	number_of_streams
	The number of streams in this connection.

StreamSettings	stream_settings [CDI_MAX_SIMULTANEOUS_TX_PAYLOADS_PER_CONNECTION]
	Array of stream settings, where each element represents a unique stream.

int	stats_period_seconds
	Statistics gathering period in seconds.

bool	multiple_endpoints
	Connection contains multiple endpoints.

CdiConnectionProtocolType	protocol_type
	Protocol type (AVM or RAW).

int	payload_size
	Payload size in bytes.

CdiTestUnitName	test_name
	Test to run.

Detailed Description

A structure that holds all the test settings for a connection as set from the command line.

A structure that holds all the test settings as set from the command line.

Field Documentation

◆ arg_error

bool TestSettings::arg_error

When true, there was an error in one or more of the command line arguments that are used to create this data structure.

◆ bind_ip_addr_str

const char * TestSettings::bind_ip_addr_str

IP address to bind to.

The adapter IP address to bind to.

◆ num_transactions

int TestSettings::num_transactions

The number of transactions in the test.

The number of transactions in the test. One transaction can transfer multiple stream payloads.

◆ rate_denominator

int TestSettings::rate_denominator

The denominator for the number of payloads per second to send during the test.

The denominator for the number of payloads per second to send.

◆ rate_numerator

int TestSettings::rate_numerator

The numerator for the number of payloads per second to send during the test.

The numerator for the number of payloads per second to send.

◆ shared_thread_id

int TestSettings::shared_thread_id

The identifier of the single poll thread to share with this connection; 0 or -1 creates a unique poll thread associated only with this connection.

◆ tx_timeout

int TestSettings::tx_timeout

The transmit timeout in microseconds for a Tx payload.

The transmit timeout in microseconds for a tx payload.

The documentation for this struct was generated from the following files:

src/ndi_test/ndi_test.h
src/test/test_args.h
src/test_minimal/test_minimal_receiver.c
src/test_minimal/test_minimal_transmitter.c
src/test_unit/test_unit.c

Data Fields