Specialized list of file names and an associated repetition rates. More...

#include <tsFileNameRateList.h>

Inheritance diagram for ts::FileNameRateList:

Collaboration diagram for ts::FileNameRateList:

Public Types
using	SuperClass = std::list< FileNameRate >
	Reference to the superclass.

Public Member Functions
	FileNameRateList ()=default
	Default constructor.

	FileNameRateList (const FileNameRateList &other)
	Copy constructor.

bool	getArgs (Args &args, const UChar *option_name=nullptr, cn::milliseconds default_rate=cn::milliseconds::zero())
	Decode a list of parameters containing a list of file names with optional repetition rates in milliseconds.

size_t	scanFiles (size_t retry=1, Report &report=(ts::NullReport::Instance()))
	Scan the files for update.

Detailed Description

Specialized list of file names and an associated repetition rates.

This is typically used to handle section files to inject into transport streams.

Constructor & Destructor Documentation

ts::FileNameRateList::FileNameRateList ( const FileNameRateList & other )

inline

Copy constructor.

Parameters

[in] other Other instance to copy.

bool ts::FileNameRateList::getArgs	(	Args &	args,
		const UChar *	option_name = `nullptr`,
		cn::milliseconds	default_rate = `cn::milliseconds::zero()`
	)

Decode a list of parameters containing a list of file names with optional repetition rates in milliseconds.

Parameters

[in,out]	args	Instance of ts::Args containing the command line parameters.
[in]	option_name	The long name of an option. All values of this option are fetched. Each value must be a string "name[=value]" where value is an optional repetition rate in milliseconds.
[in]	default_rate	Default repetition rate for files without repetition rate.

Returns: True on success. On error, set error state in args and return false.

size_t ts::FileNameRateList::scanFiles	(	size_t	retry = `1`,
		Report &	report = `(ts::NullReport::Instance())`
	)

Scan the files for update.

Update the modification dates of the files.

Parameters

[in]	retry	Number of allowed retry in case of error when using the file.
[in]	report	Where to report a verbose message when a file changed.

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