Command line arguments for the class UDPReceiver. More...

#include <tsUDPReceiverArgsList.h>

Inheritance diagram for ts::UDPReceiverArgsList:

Collaboration diagram for ts::UDPReceiverArgsList:

Public Member Functions
void	defineArgs (Args &args, bool with_short_options, bool destination_is_parameter, bool multiple_receivers)
	Add command line option definitions in an Args.

bool	loadArgs (DuckContext &duck, Args &args, cn::milliseconds default_receive_timeout=cn::milliseconds(-1))
	Load arguments from command line.

Detailed Description

Command line arguments for the class UDPReceiver.

On the command line, depending on the application, zero, one, or more, receivers can be specified.

Member Function Documentation

void ts::UDPReceiverArgsList::defineArgs	(	Args &	args,
		bool	with_short_options,
		bool	destination_is_parameter,
		bool	multiple_receivers
	)

inline

Add command line option definitions in an Args.

Parameters

[in,out]	args	Command line arguments to update.
[in]	with_short_options	When true, define one-letter short options.
[in]	destination_is_parameter	When true, the destination [address:]port is defined as a mandatory parameter. When false, it is defined as option –ip–udp (optional, can be omitted)
[in]	multiple_receivers	When true, multiple destination [address:]port are allowed.

bool ts::UDPReceiverArgsList::loadArgs	(	DuckContext &	duck,
		Args &	args,
		cn::milliseconds	default_receive_timeout = `cn::milliseconds(-1)`
	)

Load arguments from command line.

Must be called after defineArgs(). Args error indicator is set in case of incorrect arguments.

Upon return, the number of elements in this instance depends on defineArgs() parameters:

Parameters

[in,out]	duck	TSDuck execution context.
[in,out]	args	Command line arguments.
[in]	default_receive_timeout	Default receive timeout in milliseconds. No timeout if zero or negative.

The documentation for this class was generated from the following file: