libzypp  13.10.6
zypp::media::TransferSettings Class Reference

Holds transfer setting. More...

#include <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...
 
 TransferSettings (const zypp::Url &url)
 Constructs the settings from a url object where. More...
 
void reset ()
 reset the settings to the defaults More...
 
void addHeader (const std::string &header)
 add a header, on the form "Foo: Bar" More...
 
Headers::const_iterator headersBegin () const
 begin iterators to additional headers More...
 
Headers::const_iterator headersEnd () const
 end iterators to additional headers More...
 
void setUserAgentString (const std::string &agent)
 sets the user agent ie: "Mozilla v3" More...
 
std::string userAgentString () const
 user agent string More...
 
void setUsername (const std::string &username)
 sets the auth username More...
 
std::string username () const
 auth username More...
 
void setPassword (const std::string &password)
 sets the auth password More...
 
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 &proxyhost)
 proxy to use if it is enabled More...
 
std::string proxy () const
 proxy host More...
 
void setProxyUsername (const std::string &proxyuser)
 sets the proxy user More...
 
std::string proxyUsername () const
 proxy auth username More...
 
void setProxyPassword (const std::string &proxypass)
 sets the proxy password More...
 
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...
 
long maxConcurrentConnections () const
 Maximum number of concurrent connections for a single transfer. More...
 
void setMaxConcurrentConnections (long v)
 Set maximum number of concurrent connections for a single transfer. More...
 
long minDownloadSpeed () const
 Minimum download speed (bytes per second) until the connection is dropped. More...
 
void setMinDownloadSpeed (long v)
 Set minimum download speed (bytes per second) until the connection is dropped. More...
 
long maxDownloadSpeed () const
 Maximum download speed (bytes per second) More...
 
void setMaxDownloadSpeed (long v)
 Set max download speed (bytes per second) More...
 
long maxSilentTries () const
 Maximum silent retries. More...
 
void setMaxSilentTries (long v)
 Set maximum silent retries. More...
 
bool verifyHostEnabled () const
 Whether to verify host for ssl. More...
 
void setVerifyHostEnabled (bool enabled)
 Sets whether to verify host for ssl. More...
 
bool verifyPeerEnabled () const
 Whether to verify peer for ssl. More...
 
void setVerifyPeerEnabled (bool enabled)
 Sets whether to verify host for ssl. More...
 
Pathname certificateAuthoritiesPath () const
 SSL certificate authorities path ( default: /etc/ssl/certs ) More...
 
void setCertificateAuthoritiesPath (const zypp::Pathname &path)
 Sets the SSL certificate authorities path. More...
 
void setAuthType (const std::string &authtype)
 set the allowed authentication types More...
 
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...
 
Pathname clientCertificatePath () const
 SSL client certificate file. More...
 
void setClientCertificatePath (const zypp::Pathname &path)
 Sets the SSL client certificate file. More...
 
Pathname clientKeyPath () const
 SSL client key file. More...
 
void setClientKeyPath (const zypp::Pathname &path)
 Sets the SSL client key file. More...
 

Protected Attributes

RWCOW_pointer< Impl_impl
 

Detailed Description

Holds transfer setting.

Definition at line 20 of file TransferSettings.h.

Member Typedef Documentation

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

Definition at line 35 of file TransferSettings.h.

Constructor & Destructor Documentation

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

Constructs a transfer program cmd line access.

Definition at line 85 of file TransferSettings.cc.

zypp::media::TransferSettings::TransferSettings ( const zypp::Url url)

Constructs the settings from a url object where.

authentication/proxy information can be extracted from the url

Member Function Documentation

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

reset the settings to the defaults

Definition at line 91 of file TransferSettings.cc.

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

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

Definition at line 96 of file TransferSettings.cc.

TransferSettings::Headers::const_iterator zypp::media::TransferSettings::headersBegin ( ) const

begin iterators to additional headers

Definition at line 101 of file TransferSettings.cc.

TransferSettings::Headers::const_iterator zypp::media::TransferSettings::headersEnd ( ) const

end iterators to additional headers

Definition at line 106 of file TransferSettings.cc.

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

sets the user agent ie: "Mozilla v3"

Definition at line 111 of file TransferSettings.cc.

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

user agent string

Definition at line 116 of file TransferSettings.cc.

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

sets the auth username

Definition at line 121 of file TransferSettings.cc.

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

auth username

Definition at line 126 of file TransferSettings.cc.

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

sets the auth password

Definition at line 131 of file TransferSettings.cc.

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

auth password

Definition at line 143 of file TransferSettings.cc.

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

returns the user and password as a user:pass string

Definition at line 148 of file TransferSettings.cc.

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

sets anonymous authentication (ie: for ftp)

Definition at line 136 of file TransferSettings.cc.

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

whether the proxy is used or not

Definition at line 157 of file TransferSettings.cc.

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

proxy is enabled

Definition at line 162 of file TransferSettings.cc.

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

proxy to use if it is enabled

Definition at line 167 of file TransferSettings.cc.

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

proxy host

Definition at line 172 of file TransferSettings.cc.

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

sets the proxy user

Definition at line 177 of file TransferSettings.cc.

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

proxy auth username

Definition at line 182 of file TransferSettings.cc.

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

sets the proxy password

Definition at line 187 of file TransferSettings.cc.

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

proxy auth password

Definition at line 192 of file TransferSettings.cc.

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

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

Definition at line 197 of file TransferSettings.cc.

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

set the connect timeout

Definition at line 216 of file TransferSettings.cc.

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

connection timeout

Definition at line 221 of file TransferSettings.cc.

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

set the transfer timeout

Definition at line 206 of file TransferSettings.cc.

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

transfer timeout

Definition at line 211 of file TransferSettings.cc.

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

Maximum number of concurrent connections for a single transfer.

Definition at line 226 of file TransferSettings.cc.

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

Set maximum number of concurrent connections for a single transfer.

Definition at line 231 of file TransferSettings.cc.

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

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

Definition at line 236 of file TransferSettings.cc.

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

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

Definition at line 241 of file TransferSettings.cc.

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

Maximum download speed (bytes per second)

Definition at line 246 of file TransferSettings.cc.

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

Set max download speed (bytes per second)

Definition at line 251 of file TransferSettings.cc.

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

Maximum silent retries.

Definition at line 256 of file TransferSettings.cc.

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

Set maximum silent retries.

Definition at line 261 of file TransferSettings.cc.

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

Whether to verify host for ssl.

Definition at line 266 of file TransferSettings.cc.

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

Sets whether to verify host for ssl.

Definition at line 271 of file TransferSettings.cc.

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

Whether to verify peer for ssl.

Definition at line 276 of file TransferSettings.cc.

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

Sets whether to verify host for ssl.

Definition at line 302 of file TransferSettings.cc.

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

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

Definition at line 307 of file TransferSettings.cc.

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

Sets the SSL certificate authorities path.

Definition at line 312 of file TransferSettings.cc.

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

set the allowed authentication types

Definition at line 317 of file TransferSettings.cc.

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

get the allowed authentication types

Definition at line 322 of file TransferSettings.cc.

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

set whether HEAD requests are allowed

Definition at line 327 of file TransferSettings.cc.

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

whether HEAD requests are allowed

Definition at line 332 of file TransferSettings.cc.

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

SSL client certificate file.

Definition at line 281 of file TransferSettings.cc.

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

Sets the SSL client certificate file.

Definition at line 286 of file TransferSettings.cc.

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

SSL client key file.

Definition at line 291 of file TransferSettings.cc.

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

Sets the SSL client key file.

Definition at line 296 of file TransferSettings.cc.

Member Data Documentation

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

Definition at line 278 of file TransferSettings.h.


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