TSDuck v3.38-3675
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::WebRequestArgs Class Reference

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

#include <tsWebRequestArgs.h>

Collaboration diagram for ts::WebRequestArgs:

Public Member Functions

 WebRequestArgs ()=default
 Constructor.
 
void defineArgs (Args &args)
 Add command line option definitions in an Args.
 
bool loadArgs (DuckContext &duck, Args &args)
 Load arguments from command line.
 

Public Attributes

cn::milliseconds connectionTimeout {}
 --connection-timeout
 
fs::path cookiesFile {}
 Cookies files (Linux only), no command line options.
 
std::multimap< UString, UStringheaders {}
 --headers
 
UString proxyHost {}
 --proxy-host
 
UString proxyPassword {}
 --proxy-password
 
uint16_t proxyPort = 0
 --proxy-port
 
UString proxyUser {}
 --proxy-user
 
cn::milliseconds receiveTimeout {}
 --receive-timeout
 
bool useCompression = false
 --compressed
 
bool useCookies = true
 Use cookies, no command line options, true by default.
 
UString userAgent {}
 --user-agent
 

Detailed Description

Command line arguments for the class WebRequest.

Member Function Documentation

◆ defineArgs()

void ts::WebRequestArgs::defineArgs ( Args args)

Add command line option definitions in an Args.

Parameters
[in,out]argsCommand line arguments to update.

◆ loadArgs()

bool ts::WebRequestArgs::loadArgs ( DuckContext duck,
Args args 
)

Load arguments from command line.

Args error indicator is set in case of incorrect arguments.

Parameters
[in,out]duckTSDuck execution context.
[in,out]argsCommand line arguments.
Returns
True on success, false on error in argument line.

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