zypp::media::TransferSettings Class Reference

Holds transfer setting. More...

#include </root/hudson/workspace/zypp/head/90-libzypp-online-doc/checkout/zypp-curl/transfersettings.h>

Classes
class	Impl

Public Types
typedef std::vector< std::string >	Headers

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

Protected Attributes
RWCOW_pointer< Impl >	_impl

Detailed Description

Holds transfer setting.

Definition at line 29 of file transfersettings.h.

Member Typedef Documentation

Headers

typedef std::vector<std::string> zypp::media::TransferSettings::Headers

Definition at line 35 of file transfersettings.h.

Constructor & Destructor Documentation

TransferSettings()

zypp::media::TransferSettings::TransferSettings

(

)

Constructs a transfer program cmd line access.

Definition at line 97 of file transfersettings.cc.

Member Function Documentation

reset()

void zypp::media::TransferSettings::reset

(

)

reset the settings to the defaults

Definition at line 101 of file transfersettings.cc.

addHeader() [1/2]

void zypp::media::TransferSettings::addHeader

(

std::string &&

val_r

)

add a header, on the form "Foo: Bar"

Definition at line 108 of file transfersettings.cc.

addHeader() [2/2]

void zypp::media::TransferSettings::addHeader

(

const std::string &

val_r

)

Definition at line 105 of file transfersettings.cc.

headers()

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

(

)

const

returns a list of all added headers

Definition at line 111 of file transfersettings.cc.

setUserAgentString() [1/2]

void zypp::media::TransferSettings::setUserAgentString

(

std::string &&

val_r

)

sets the user agent ie: "Mozilla v3"

Definition at line 120 of file transfersettings.cc.

setUserAgentString() [2/2]

void zypp::media::TransferSettings::setUserAgentString

(

const std::string &&

val_r

)

Definition at line 117 of file transfersettings.cc.

userAgentString()

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

(

)

const

user agent string

Definition at line 123 of file transfersettings.cc.

setUsername() [1/2]

void zypp::media::TransferSettings::setUsername

(

const std::string &

val_r

)

sets the auth username

Definition at line 127 of file transfersettings.cc.

setUsername() [2/2]

void zypp::media::TransferSettings::setUsername

(

std::string &&

val_r

)

Definition at line 130 of file transfersettings.cc.

username()

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

(

)

const

auth username

Definition at line 133 of file transfersettings.cc.

setPassword() [1/2]

void zypp::media::TransferSettings::setPassword

(

const std::string &

val_r

)

sets the auth password

Definition at line 136 of file transfersettings.cc.

setPassword() [2/2]

void zypp::media::TransferSettings::setPassword

(

std::string &&

val_r

)

Definition at line 139 of file transfersettings.cc.

password()

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

(

)

const

auth password

Definition at line 142 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 145 of file transfersettings.cc.

setAnonymousAuth()

void zypp::media::TransferSettings::setAnonymousAuth

(

)

sets anonymous authentication (ie: for ftp)

Definition at line 154 of file transfersettings.cc.

setProxyEnabled()

void zypp::media::TransferSettings::setProxyEnabled

(

bool

enabled

)

whether the proxy is used or not

Definition at line 161 of file transfersettings.cc.

proxyEnabled()

bool zypp::media::TransferSettings::proxyEnabled

(

)

const

proxy is enabled

Definition at line 164 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 168 of file transfersettings.cc.

setProxy() [2/2]

void zypp::media::TransferSettings::setProxy

(

std::string &&

val_r

)

Definition at line 171 of file transfersettings.cc.

proxy()

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

(

)

const

proxy host

Definition at line 174 of file transfersettings.cc.

setProxyUsername() [1/2]

void zypp::media::TransferSettings::setProxyUsername

(

const std::string &

val_r

)

sets the proxy user

Definition at line 178 of file transfersettings.cc.

setProxyUsername() [2/2]

void zypp::media::TransferSettings::setProxyUsername

(

std::string &&

val_r

)

Definition at line 181 of file transfersettings.cc.

proxyUsername()

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

(

)

const

proxy auth username

Definition at line 184 of file transfersettings.cc.

setProxyPassword() [1/2]

void zypp::media::TransferSettings::setProxyPassword

(

const std::string &

val_r

)

sets the proxy password

Definition at line 187 of file transfersettings.cc.

setProxyPassword() [2/2]

void zypp::media::TransferSettings::setProxyPassword

(

std::string &&

val_r

)

Definition at line 190 of file transfersettings.cc.

proxyPassword()

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

(

)

const

proxy auth password

Definition at line 193 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 196 of file transfersettings.cc.

setConnectTimeout()

void zypp::media::TransferSettings::setConnectTimeout

(

long

t

)

set the connect timeout

Definition at line 213 of file transfersettings.cc.

connectTimeout()

long zypp::media::TransferSettings::connectTimeout

(

)

const

connection timeout

Definition at line 216 of file transfersettings.cc.

setTimeout()

void zypp::media::TransferSettings::setTimeout

(

long

t

)

set the transfer timeout

Definition at line 206 of file transfersettings.cc.

timeout()

long zypp::media::TransferSettings::timeout

(

)

const

transfer timeout

Definition at line 209 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 220 of file transfersettings.cc.

maxConcurrentConnections()

long zypp::media::TransferSettings::maxConcurrentConnections

(

)

const

Maximum number of concurrent connections for a single transfer.

Definition at line 223 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 227 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 230 of file transfersettings.cc.

setMaxDownloadSpeed()

void zypp::media::TransferSettings::setMaxDownloadSpeed

(

long

v

)

Set max download speed (bytes per second)

Definition at line 234 of file transfersettings.cc.

maxDownloadSpeed()

long zypp::media::TransferSettings::maxDownloadSpeed

(

)

const

Maximum download speed (bytes per second)

Definition at line 237 of file transfersettings.cc.

setMaxSilentTries()

void zypp::media::TransferSettings::setMaxSilentTries

(

long

v

)

Set maximum silent retries.

Definition at line 241 of file transfersettings.cc.

maxSilentTries()

long zypp::media::TransferSettings::maxSilentTries

(

)

const

Maximum silent retries.

Definition at line 244 of file transfersettings.cc.

setVerifyHostEnabled()

void zypp::media::TransferSettings::setVerifyHostEnabled

(

bool

enabled

)

Sets whether to verify host for ssl.

Definition at line 248 of file transfersettings.cc.

verifyHostEnabled()

bool zypp::media::TransferSettings::verifyHostEnabled

(

)

const

Whether to verify host for ssl.

Definition at line 251 of file transfersettings.cc.

setVerifyPeerEnabled()

void zypp::media::TransferSettings::setVerifyPeerEnabled

(

bool

enabled

)

Sets whether to verify host for ssl.

Definition at line 255 of file transfersettings.cc.

verifyPeerEnabled()

bool zypp::media::TransferSettings::verifyPeerEnabled

(

)

const

Whether to verify peer for ssl.

Definition at line 258 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 281 of file transfersettings.cc.

setCertificateAuthoritiesPath() [2/2]

void zypp::media::TransferSettings::setCertificateAuthoritiesPath

(

Pathname &&

val_r

)

Definition at line 284 of file transfersettings.cc.

certificateAuthoritiesPath()

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

(

)

const

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

Definition at line 287 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 291 of file transfersettings.cc.

setAuthType() [2/2]

void zypp::media::TransferSettings::setAuthType

(

std::string &&

val_r

)

Definition at line 294 of file transfersettings.cc.

authType()

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

(

)

const

get the allowed authentication types

Definition at line 297 of file transfersettings.cc.

setHeadRequestsAllowed()

void zypp::media::TransferSettings::setHeadRequestsAllowed

(

bool

allowed

)

set whether HEAD requests are allowed

Definition at line 301 of file transfersettings.cc.

headRequestsAllowed()

bool zypp::media::TransferSettings::headRequestsAllowed

(

)

const

whether HEAD requests are allowed

Definition at line 304 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 261 of file transfersettings.cc.

setClientCertificatePath() [2/2]

void zypp::media::TransferSettings::setClientCertificatePath

(

Pathname &&

val_r

)

Definition at line 264 of file transfersettings.cc.

clientCertificatePath()

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

(

)

const

SSL client certificate file.

Definition at line 267 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 271 of file transfersettings.cc.

setClientKeyPath() [2/2]

void zypp::media::TransferSettings::setClientKeyPath

(

Pathname &&

val_r

)

Definition at line 274 of file transfersettings.cc.

clientKeyPath()

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

(

)

const

SSL client key file.

Definition at line 277 of file transfersettings.cc.

Member Data Documentation

_impl

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

protected

Definition at line 205 of file transfersettings.h.

---

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

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