Holds transfer setting. More...

#include <zypp-curl/transfersettings.h>

Classes
class	Impl

Public Types
using	Headers = std::vector<std::string>

Public Member Functions
	TransferSettings ()
	Constructs a transfer program cmd line access.
void	reset ()
	reset the settings to the defaults
void	addHeader (std::string &&val_r)
	add a header, on the form "Foo: Bar" (trims)
void	addHeader (const std::string &val_r)
const Headers &	headers () const
	returns a list of all added headers (trimmed)
void	setUserAgentString (std::string &&val_r)
	sets the user agent ie: "Mozilla v3" (trims)
void	setUserAgentString (const std::string &val_r)
const std::string &	userAgentString () const
	user agent string (trimmed)
void	setUsername (const std::string &val_r)
	sets the auth username
void	setUsername (std::string &&val_r)
const std::string &	username () const
	auth username
void	setPassword (const std::string &val_r)
	sets the auth password
void	setPassword (std::string &&val_r)
const std::string &	password () const
	auth password
std::string	userPassword () const
	returns the user and password as a user:pass string
void	setAnonymousAuth ()
	sets anonymous authentication (ie: for ftp)
void	setProxyEnabled (bool enabled)
	whether the proxy is used or not
bool	proxyEnabled () const
	proxy is enabled
void	setProxy (const std::string &val_r)
	proxy to use if it is enabled
void	setProxy (std::string &&val_r)
const std::string &	proxy () const
	proxy host
void	setProxyUsername (const std::string &val_r)
	sets the proxy user
void	setProxyUsername (std::string &&val_r)
const std::string &	proxyUsername () const
	proxy auth username
void	setProxyPassword (const std::string &val_r)
	sets the proxy password
void	setProxyPassword (std::string &&val_r)
const std::string &	proxyPassword () const
	proxy auth password
std::string	proxyUserPassword () const
	returns the proxy user and password as a user:pass string
void	setConnectTimeout (long t)
	set the connect timeout
long	connectTimeout () const
	connection timeout
void	setTimeout (long t)
	set the transfer timeout
long	timeout () const
	transfer timeout
void	setMaxConcurrentConnections (long v)
	Set maximum number of concurrent connections for a single transfer.
long	maxConcurrentConnections () const
	Maximum number of concurrent connections for a single transfer.
void	setMinDownloadSpeed (long v)
	Set minimum download speed (bytes per second) until the connection is dropped.
long	minDownloadSpeed () const
	Minimum download speed (bytes per second) until the connection is dropped.
void	setMaxDownloadSpeed (long v)
	Set max download speed (bytes per second)
long	maxDownloadSpeed () const
	Maximum download speed (bytes per second)
void	setMaxSilentTries (long v)
	Set maximum silent retries.
long	maxSilentTries () const
	Maximum silent retries.
void	setVerifyHostEnabled (bool enabled)
	Sets whether to verify host for ssl.
bool	verifyHostEnabled () const
	Whether to verify host for ssl.
void	setVerifyPeerEnabled (bool enabled)
	Sets whether to verify host for ssl.
bool	verifyPeerEnabled () const
	Whether to verify peer for ssl.
void	setCertificateAuthoritiesPath (const Pathname &val_r)
	Sets the SSL certificate authorities path.
void	setCertificateAuthoritiesPath (Pathname &&val_r)
const Pathname &	certificateAuthoritiesPath () const
	SSL certificate authorities path ( default: /etc/ssl/certs )
void	setAuthType (const std::string &val_r)
	set the allowed authentication types
void	setAuthType (std::string &&val_r)
const std::string &	authType () const
	get the allowed authentication types
void	setHeadRequestsAllowed (bool allowed)
	set whether HEAD requests are allowed
bool	headRequestsAllowed () const
	whether HEAD requests are allowed
void	setClientCertificatePath (const Pathname &val_r)
	Sets the SSL client certificate file.
void	setClientCertificatePath (Pathname &&val_r)
const Pathname &	clientCertificatePath () const
	SSL client certificate file.
void	setClientKeyPath (const Pathname &val_r)
	Sets the SSL client key file.
void	setClientKeyPath (Pathname &&val_r)
const Pathname &	clientKeyPath () const
	SSL client key file.
void	setEnableCookieFile (bool enable=true)
	Enable or disable the use of the cookie file.
bool	cookieFileEnabled () const

Protected Attributes
RWCOW_pointer< Impl >	_impl

Detailed Description

Holds transfer setting.

Note: bsc#1212187: HTTP/2 RFC 9113 forbids fields ending with a space. The class asserts headers and userAgentString return trimmed strings. Strings are trimmed when set. Empty

Definition at line 33 of file transfersettings.h.

Member Typedef Documentation

◆ Headers

using zypp::media::TransferSettings::Headers = std::vector<std::string>

Definition at line 39 of file transfersettings.h.

Constructor & Destructor Documentation

◆ TransferSettings()

zypp::media::TransferSettings::TransferSettings ( )

Constructs a transfer program cmd line access.

Definition at line 114 of file transfersettings.cc.

Member Function Documentation

◆ reset()

void zypp::media::TransferSettings::reset ( )

reset the settings to the defaults

Definition at line 118 of file transfersettings.cc.

◆ addHeader() [1/2]

void zypp::media::TransferSettings::addHeader ( std::string && val_r )

add a header, on the form "Foo: Bar" (trims)

Definition at line 124 of file transfersettings.cc.

◆ addHeader() [2/2]

void zypp::media::TransferSettings::addHeader ( const std::string & val_r )

Definition at line 122 of file transfersettings.cc.

◆ headers()

const TransferSettings::Headers & zypp::media::TransferSettings::headers ( ) const

returns a list of all added headers (trimmed)

Definition at line 127 of file transfersettings.cc.

◆ setUserAgentString() [1/2]

void zypp::media::TransferSettings::setUserAgentString ( std::string && val_r )

sets the user agent ie: "Mozilla v3" (trims)

Definition at line 136 of file transfersettings.cc.

◆ setUserAgentString() [2/2]

void zypp::media::TransferSettings::setUserAgentString ( const std::string & val_r )

Definition at line 133 of file transfersettings.cc.

◆ userAgentString()

const std::string & zypp::media::TransferSettings::userAgentString ( ) const

user agent string (trimmed)

Definition at line 139 of file transfersettings.cc.

◆ setUsername() [1/2]

void zypp::media::TransferSettings::setUsername ( const std::string & val_r )

sets the auth username

Definition at line 143 of file transfersettings.cc.

◆ setUsername() [2/2]

void zypp::media::TransferSettings::setUsername ( std::string && val_r )

Definition at line 146 of file transfersettings.cc.

◆ username()

const std::string & zypp::media::TransferSettings::username ( ) const

auth username

Definition at line 149 of file transfersettings.cc.

◆ setPassword() [1/2]

void zypp::media::TransferSettings::setPassword ( const std::string & val_r )

sets the auth password

Definition at line 152 of file transfersettings.cc.

◆ setPassword() [2/2]

void zypp::media::TransferSettings::setPassword ( std::string && val_r )

Definition at line 155 of file transfersettings.cc.

◆ password()

const std::string & zypp::media::TransferSettings::password ( ) const

auth password

Definition at line 158 of file transfersettings.cc.

◆ userPassword()

std::string zypp::media::TransferSettings::userPassword ( ) const

returns the user and password as a user:pass string

Definition at line 161 of file transfersettings.cc.

◆ setAnonymousAuth()

void zypp::media::TransferSettings::setAnonymousAuth ( )

sets anonymous authentication (ie: for ftp)

Definition at line 170 of file transfersettings.cc.

◆ setProxyEnabled()

void zypp::media::TransferSettings::setProxyEnabled ( bool enabled )

whether the proxy is used or not

Definition at line 177 of file transfersettings.cc.

◆ proxyEnabled()

bool zypp::media::TransferSettings::proxyEnabled ( ) const

proxy is enabled

Definition at line 180 of file transfersettings.cc.

◆ setProxy() [1/2]

void zypp::media::TransferSettings::setProxy ( const std::string & val_r )

proxy to use if it is enabled

Definition at line 184 of file transfersettings.cc.

◆ setProxy() [2/2]

void zypp::media::TransferSettings::setProxy ( std::string && val_r )

Definition at line 187 of file transfersettings.cc.

◆ proxy()

const std::string & zypp::media::TransferSettings::proxy ( ) const

proxy host

Definition at line 190 of file transfersettings.cc.

◆ setProxyUsername() [1/2]

void zypp::media::TransferSettings::setProxyUsername ( const std::string & val_r )

sets the proxy user

Definition at line 194 of file transfersettings.cc.

◆ setProxyUsername() [2/2]

void zypp::media::TransferSettings::setProxyUsername ( std::string && val_r )

Definition at line 197 of file transfersettings.cc.

◆ proxyUsername()

const std::string & zypp::media::TransferSettings::proxyUsername ( ) const

proxy auth username

Definition at line 200 of file transfersettings.cc.

◆ setProxyPassword() [1/2]

void zypp::media::TransferSettings::setProxyPassword ( const std::string & val_r )

sets the proxy password

Definition at line 203 of file transfersettings.cc.

◆ setProxyPassword() [2/2]

void zypp::media::TransferSettings::setProxyPassword ( std::string && val_r )

Definition at line 206 of file transfersettings.cc.

◆ proxyPassword()

const std::string & zypp::media::TransferSettings::proxyPassword ( ) const

proxy auth password

Definition at line 209 of file transfersettings.cc.

◆ proxyUserPassword()

std::string zypp::media::TransferSettings::proxyUserPassword ( ) const

returns the proxy user and password as a user:pass string

Definition at line 212 of file transfersettings.cc.

◆ setConnectTimeout()

void zypp::media::TransferSettings::setConnectTimeout ( long t )

set the connect timeout

Definition at line 229 of file transfersettings.cc.

◆ connectTimeout()

long zypp::media::TransferSettings::connectTimeout ( ) const

connection timeout

Definition at line 232 of file transfersettings.cc.

◆ setTimeout()

void zypp::media::TransferSettings::setTimeout ( long t )

set the transfer timeout

Definition at line 222 of file transfersettings.cc.

◆ timeout()

long zypp::media::TransferSettings::timeout ( ) const

transfer timeout

Definition at line 225 of file transfersettings.cc.

◆ setMaxConcurrentConnections()

void zypp::media::TransferSettings::setMaxConcurrentConnections ( long v )

Set maximum number of concurrent connections for a single transfer.

Definition at line 236 of file transfersettings.cc.

◆ maxConcurrentConnections()

long zypp::media::TransferSettings::maxConcurrentConnections ( ) const

Maximum number of concurrent connections for a single transfer.

Definition at line 239 of file transfersettings.cc.

◆ setMinDownloadSpeed()

void zypp::media::TransferSettings::setMinDownloadSpeed ( long v )

Set minimum download speed (bytes per second) until the connection is dropped.

Definition at line 243 of file transfersettings.cc.

◆ minDownloadSpeed()

long zypp::media::TransferSettings::minDownloadSpeed ( ) const

Minimum download speed (bytes per second) until the connection is dropped.

Definition at line 246 of file transfersettings.cc.

◆ setMaxDownloadSpeed()

void zypp::media::TransferSettings::setMaxDownloadSpeed ( long v )

Set max download speed (bytes per second)

Definition at line 250 of file transfersettings.cc.

◆ maxDownloadSpeed()

long zypp::media::TransferSettings::maxDownloadSpeed ( ) const

Maximum download speed (bytes per second)

Definition at line 253 of file transfersettings.cc.

◆ setMaxSilentTries()

void zypp::media::TransferSettings::setMaxSilentTries ( long v )

Set maximum silent retries.

Definition at line 257 of file transfersettings.cc.

◆ maxSilentTries()

long zypp::media::TransferSettings::maxSilentTries ( ) const

Maximum silent retries.

Definition at line 260 of file transfersettings.cc.

◆ setVerifyHostEnabled()

void zypp::media::TransferSettings::setVerifyHostEnabled ( bool enabled )

Sets whether to verify host for ssl.

Definition at line 264 of file transfersettings.cc.

◆ verifyHostEnabled()

bool zypp::media::TransferSettings::verifyHostEnabled ( ) const

Whether to verify host for ssl.

Definition at line 267 of file transfersettings.cc.

◆ setVerifyPeerEnabled()

void zypp::media::TransferSettings::setVerifyPeerEnabled ( bool enabled )

Sets whether to verify host for ssl.

Definition at line 271 of file transfersettings.cc.

◆ verifyPeerEnabled()

bool zypp::media::TransferSettings::verifyPeerEnabled ( ) const

Whether to verify peer for ssl.

Definition at line 274 of file transfersettings.cc.

◆ setCertificateAuthoritiesPath() [1/2]

void zypp::media::TransferSettings::setCertificateAuthoritiesPath ( const Pathname & val_r )

Sets the SSL certificate authorities path.

Definition at line 302 of file transfersettings.cc.

◆ setCertificateAuthoritiesPath() [2/2]

void zypp::media::TransferSettings::setCertificateAuthoritiesPath ( Pathname && val_r )

Definition at line 305 of file transfersettings.cc.

◆ certificateAuthoritiesPath()

const Pathname & zypp::media::TransferSettings::certificateAuthoritiesPath ( ) const

SSL certificate authorities path ( default: /etc/ssl/certs )

Definition at line 308 of file transfersettings.cc.

◆ setAuthType() [1/2]

void zypp::media::TransferSettings::setAuthType ( const std::string & val_r )

set the allowed authentication types

Definition at line 312 of file transfersettings.cc.

◆ setAuthType() [2/2]

void zypp::media::TransferSettings::setAuthType ( std::string && val_r )

Definition at line 315 of file transfersettings.cc.

◆ authType()

const std::string & zypp::media::TransferSettings::authType ( ) const

get the allowed authentication types

Definition at line 318 of file transfersettings.cc.

◆ setHeadRequestsAllowed()

void zypp::media::TransferSettings::setHeadRequestsAllowed ( bool allowed )

set whether HEAD requests are allowed

Definition at line 322 of file transfersettings.cc.

◆ headRequestsAllowed()

bool zypp::media::TransferSettings::headRequestsAllowed ( ) const

whether HEAD requests are allowed

Definition at line 325 of file transfersettings.cc.

◆ setClientCertificatePath() [1/2]

void zypp::media::TransferSettings::setClientCertificatePath ( const Pathname & val_r )

Sets the SSL client certificate file.

Definition at line 277 of file transfersettings.cc.

◆ setClientCertificatePath() [2/2]

void zypp::media::TransferSettings::setClientCertificatePath ( Pathname && val_r )

Definition at line 280 of file transfersettings.cc.

◆ clientCertificatePath()

const Pathname & zypp::media::TransferSettings::clientCertificatePath ( ) const

SSL client certificate file.

Definition at line 283 of file transfersettings.cc.

◆ setClientKeyPath() [1/2]

void zypp::media::TransferSettings::setClientKeyPath ( const Pathname & val_r )

Sets the SSL client key file.

Definition at line 287 of file transfersettings.cc.

◆ setClientKeyPath() [2/2]

void zypp::media::TransferSettings::setClientKeyPath ( Pathname && val_r )

Definition at line 290 of file transfersettings.cc.

◆ clientKeyPath()

const Pathname & zypp::media::TransferSettings::clientKeyPath ( ) const

SSL client key file.

Definition at line 293 of file transfersettings.cc.

◆ setEnableCookieFile()

void zypp::media::TransferSettings::setEnableCookieFile ( bool enable = true )

Enable or disable the use of the cookie file.

Definition at line 296 of file transfersettings.cc.

◆ cookieFileEnabled()

bool zypp::media::TransferSettings::cookieFileEnabled ( ) const

Definition at line 299 of file transfersettings.cc.

Member Data Documentation

◆ _impl

RWCOW_pointer<Impl> zypp::media::TransferSettings::_impl

protected

Definition at line 213 of file transfersettings.h.

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

zypp-curl/transfersettings.h
zypp-curl/transfersettings.cc

Classes

Public Types

Public Member Functions

Protected Attributes