libzypp  17.31.31
transfersettings.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED
13 #define ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED
14 
15 #include <string>
16 #include <vector>
17 #include <zypp-core/base/Flags.h>
18 #include <zypp-core/base/PtrTypes.h>
19 #include <zypp-core/Pathname.h>
20 #include <zypp-core/Url.h>
21 namespace zypp
22 {
23  namespace media
24  {
25 
32  // strings are discarded.
34  {
35  public:
38 
39  typedef std::vector<std::string> Headers;
40 
42  void reset();
43 
45  void addHeader( std::string && val_r );
46  void addHeader( const std::string & val_r );
47 
49  const Headers &headers() const;
50 
52  void setUserAgentString( std::string && val_r );
53  void setUserAgentString( const std::string &val_r );
54 
56  const std::string &userAgentString() const;
57 
58 
60  void setUsername( const std::string &val_r );
61  void setUsername( std::string && val_r );
62 
64  const std::string &username() const;
65 
67  void setPassword( const std::string & val_r );
68  void setPassword( std::string && val_r );
69 
71  const std::string &password() const;
72 
74  std::string userPassword() const;
75 
77  void setAnonymousAuth();
78 
79 
81  void setProxyEnabled( bool enabled );
82 
84  bool proxyEnabled() const;
85 
86 
88  void setProxy( const std::string &val_r );
89  void setProxy( std::string && val_r );
90 
92  const std::string &proxy() const;
93 
94 
96  void setProxyUsername( const std::string &val_r );
97  void setProxyUsername( std::string && val_r );
98 
100  const std::string &proxyUsername() const;
101 
103  void setProxyPassword( const std::string &val_r );
104  void setProxyPassword( std::string && val_r );
105 
107  const std::string &proxyPassword() const;
108 
110  std::string proxyUserPassword() const;
111 
112 
114  void setConnectTimeout( long t );
115 
117  long connectTimeout() const;
118 
119 
121  void setTimeout( long t );
122 
124  long timeout() const;
125 
126 
128  void setMaxConcurrentConnections(long v);
129 
131  long maxConcurrentConnections() const;
132 
133 
135  void setMinDownloadSpeed(long v);
136 
138  long minDownloadSpeed() const;
139 
140 
142  void setMaxDownloadSpeed(long v);
143 
145  long maxDownloadSpeed() const;
146 
147 
149  void setMaxSilentTries(long v);
150 
152  long maxSilentTries() const;
153 
154 
156  void setVerifyHostEnabled( bool enabled );
157 
159  bool verifyHostEnabled() const;
160 
161 
163  void setVerifyPeerEnabled( bool enabled );
164 
166  bool verifyPeerEnabled() const;
167 
168 
170  void setCertificateAuthoritiesPath( const Pathname &val_r );
171  void setCertificateAuthoritiesPath( Pathname && val_r );
172 
174  const Pathname &certificateAuthoritiesPath() const;
175 
176 
178  void setAuthType( const std::string &val_r );
179  void setAuthType( std::string && val_r );
180 
182  const std::string &authType() const;
183 
184 
186  void setHeadRequestsAllowed(bool allowed);
187 
189  bool headRequestsAllowed() const;
190 
191 
193  void setClientCertificatePath( const Pathname &val_r );
194  void setClientCertificatePath( Pathname && val_r );
195 
197  const Pathname &clientCertificatePath() const;
198 
199 
201  void setClientKeyPath( const Pathname &val_r );
202  void setClientKeyPath( Pathname && val_r );
203 
205  const Pathname &clientKeyPath() const;
206 
207  protected:
208  class Impl;
210  };
211 
212  } // namespace media
213 } // namespece zypp
214 
215 #endif // ZYPP_CURL_TRANSFER_SETTINGS_H_INCLUDED
long timeout() const
transfer timeout
const Pathname & certificateAuthoritiesPath() const
SSL certificate authorities path ( default: /etc/ssl/certs )
const Pathname & clientCertificatePath() const
SSL client certificate file.
void addHeader(std::string &&val_r)
add a header, on the form "Foo: Bar" (trims)
std::string proxyUserPassword() const
returns the proxy user and password as a user:pass string
const std::string & proxyPassword() const
proxy auth password
void setPassword(const std::string &val_r)
sets the auth password
long maxDownloadSpeed() const
Maximum download speed (bytes per second)
Holds transfer setting.
const std::string & authType() const
get the allowed authentication types
bool verifyHostEnabled() const
Whether to verify host for ssl.
const std::string & proxyUsername() const
proxy auth username
void setUsername(const std::string &val_r)
sets the auth username
void setHeadRequestsAllowed(bool allowed)
set whether HEAD requests are allowed
void setConnectTimeout(long t)
set the connect timeout
const std::string & password() const
auth password
const std::string & username() const
auth username
const Headers & headers() const
returns a list of all added headers (trimmed)
void setAnonymousAuth()
sets anonymous authentication (ie: for ftp)
bool verifyPeerEnabled() const
Whether to verify peer for ssl.
long maxSilentTries() const
Maximum silent retries.
void setAuthType(const std::string &val_r)
set the allowed authentication types
void setProxy(const std::string &val_r)
proxy to use if it is enabled
long connectTimeout() const
connection timeout
std::vector< std::string > Headers
TransferSettings()
Constructs a transfer program cmd line access.
void setMaxSilentTries(long v)
Set maximum silent retries.
void setTimeout(long t)
set the transfer timeout
const Pathname & clientKeyPath() const
SSL client key file.
RWCOW_pointer< Impl > _impl
void setMaxDownloadSpeed(long v)
Set max download speed (bytes per second)
long minDownloadSpeed() const
Minimum download speed (bytes per second) until the connection is dropped.
bool proxyEnabled() const
proxy is enabled
void setProxyPassword(const std::string &val_r)
sets the proxy password
void reset()
reset the settings to the defaults
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 setUserAgentString(std::string &&val_r)
sets the user agent ie: "Mozilla v3" (trims)
void setClientCertificatePath(const Pathname &val_r)
Sets the SSL client certificate file.
void setProxyUsername(const std::string &val_r)
sets the proxy user
std::string userPassword() const
returns the user and password as a user:pass string
void setCertificateAuthoritiesPath(const Pathname &val_r)
Sets the SSL certificate authorities path.
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
void setMinDownloadSpeed(long v)
Set minimum download speed (bytes per second) until the connection is dropped.
const std::string & proxy() const
proxy host
void setVerifyPeerEnabled(bool enabled)
Sets whether to verify host for ssl.
void setClientKeyPath(const Pathname &val_r)
Sets the SSL client key file.
void setVerifyHostEnabled(bool enabled)
Sets whether to verify host for ssl.
const std::string & userAgentString() const
user agent string (trimmed)
bool headRequestsAllowed() const
whether HEAD requests are allowed
void setProxyEnabled(bool enabled)
whether the proxy is used or not