libzypp  17.25.2
TransferSettings.h
Go to the documentation of this file.
1 
2 #ifndef TRANSFER_SETTINGS_H_
3 #define TRANSFER_SETTINGS_H_
4 
5 #include <string>
6 #include <vector>
7 #include <zypp/base/Flags.h>
8 #include <zypp/base/PtrTypes.h>
9 #include <zypp/Pathname.h>
10 #include <zypp/Url.h>
11 
12 namespace zypp::proto {
13  class TransferSettings;
14 }
15 
16 namespace zypp
17 {
18  namespace media
19  {
20 
25  {
26  public:
29 
30  TransferSettings( const zypp::proto::TransferSettings &settings );
31 
32  typedef std::vector<std::string> Headers;
33 
35  void reset();
36 
37 
39  void addHeader( std::string && val_r );
40 
42  Headers headers() const;
43 
45  void setUserAgentString( std::string && val_r );
46 
48  std::string userAgentString() const;
49 
50 
52  void setUsername( std::string && val_r );
53 
55  std::string username() const;
56 
58  void setPassword( std::string && val_r );
59 
61  std::string password() const;
62 
64  std::string userPassword() const;
65 
67  void setAnonymousAuth();
68 
69 
71  void setProxyEnabled( bool enabled );
72 
74  bool proxyEnabled() const;
75 
76 
78  void setProxy( std::string && val_r );
79 
81  std::string proxy() const;
82 
83 
85  void setProxyUsername( std::string && val_r );
86 
88  std::string proxyUsername() const;
89 
91  void setProxyPassword( std::string && val_r );
92 
94  std::string proxyPassword() const;
95 
97  std::string proxyUserPassword() const;
98 
99 
101  void setConnectTimeout( long t );
102 
104  long connectTimeout() const;
105 
106 
108  void setTimeout( long t );
109 
111  long timeout() const;
112 
113 
115  void setMaxConcurrentConnections(long v);
116 
118  long maxConcurrentConnections() const;
119 
120 
122  void setMinDownloadSpeed(long v);
123 
125  long minDownloadSpeed() const;
126 
127 
129  void setMaxDownloadSpeed(long v);
130 
132  long maxDownloadSpeed() const;
133 
134 
136  void setMaxSilentTries(long v);
137 
139  long maxSilentTries() const;
140 
141 
143  void setVerifyHostEnabled( bool enabled );
144 
146  bool verifyHostEnabled() const;
147 
148 
150  void setVerifyPeerEnabled( bool enabled );
151 
153  bool verifyPeerEnabled() const;
154 
155 
157  void setCertificateAuthoritiesPath( Pathname && val_r );
158 
161 
162 
164  void setAuthType( std::string && val_r );
165 
167  std::string authType() const;
168 
169 
171  void setHeadRequestsAllowed(bool allowed);
172 
174  bool headRequestsAllowed() const;
175 
176 
178  void setClientCertificatePath( Pathname && val_r );
179 
182 
183 
185  void setClientKeyPath( Pathname && val_r );
186 
188  Pathname clientKeyPath() const;
189 
190  const zypp::proto::TransferSettings &protoData() const;
191  zypp::proto::TransferSettings &protoData();
192 
193  protected:
194  class Impl;
196  };
197 
198  } // namespace media
199 } // namespece zypp
200 
201 #endif
zypp::media::TransferSettings::verifyHostEnabled
bool verifyHostEnabled() const
Whether to verify host for ssl.
Definition: TransferSettings.cc:204
zypp::media::TransferSettings::verifyPeerEnabled
bool verifyPeerEnabled() const
Whether to verify peer for ssl.
Definition: TransferSettings.cc:211
zypp::media::TransferSettings::setConnectTimeout
void setConnectTimeout(long t)
set the connect timeout
Definition: TransferSettings.cc:166
zypp::media::TransferSettings::userPassword
std::string userPassword() const
returns the user and password as a user:pass string
Definition: TransferSettings.cc:107
zypp::media::TransferSettings::reset
void reset()
reset the settings to the defaults
Definition: TransferSettings.cc:71
zypp::media::TransferSettings::proxyPassword
std::string proxyPassword() const
proxy auth password
Definition: TransferSettings.cc:146
zypp::media::TransferSettings::setTimeout
void setTimeout(long t)
set the transfer timeout
Definition: TransferSettings.cc:159
zypp::media::TransferSettings::setMaxSilentTries
void setMaxSilentTries(long v)
Set maximum silent retries.
Definition: TransferSettings.cc:194
zypp::media::TransferSettings::username
std::string username() const
auth username
Definition: TransferSettings.cc:98
zypp::media::TransferSettings::minDownloadSpeed
long minDownloadSpeed() const
Minimum download speed (bytes per second) until the connection is dropped.
Definition: TransferSettings.cc:183
zypp::media::TransferSettings::certificateAuthoritiesPath
Pathname certificateAuthoritiesPath() const
SSL certificate authorities path ( default: /etc/ssl/certs )
Definition: TransferSettings.cc:241
zypp::media::TransferSettings::timeout
long timeout() const
transfer timeout
Definition: TransferSettings.cc:162
zypp::media::TransferSettings::authType
std::string authType() const
get the allowed authentication types
Definition: TransferSettings.cc:248
zypp::media::TransferSettings::setMaxConcurrentConnections
void setMaxConcurrentConnections(long v)
Set maximum number of concurrent connections for a single transfer.
Definition: TransferSettings.cc:173
zypp::media::TransferSettings::maxConcurrentConnections
long maxConcurrentConnections() const
Maximum number of concurrent connections for a single transfer.
Definition: TransferSettings.cc:176
PtrTypes.h
Pathname.h
zypp::media::TransferSettings::proxyUserPassword
std::string proxyUserPassword() const
returns the proxy user and password as a user:pass string
Definition: TransferSettings.cc:149
zypp::media::TransferSettings::headRequestsAllowed
bool headRequestsAllowed() const
whether HEAD requests are allowed
Definition: TransferSettings.cc:255
zypp::media::TransferSettings::setVerifyHostEnabled
void setVerifyHostEnabled(bool enabled)
Sets whether to verify host for ssl.
Definition: TransferSettings.cc:201
zypp::media::TransferSettings::proxyEnabled
bool proxyEnabled() const
proxy is enabled
Definition: TransferSettings.cc:126
zypp::media::TransferSettings
Holds transfer setting.
Definition: TransferSettings.h:25
zypp::media::TransferSettings::TransferSettings
TransferSettings(const zypp::proto::TransferSettings &settings)
zypp::media::TransferSettings::setProxyEnabled
void setProxyEnabled(bool enabled)
whether the proxy is used or not
Definition: TransferSettings.cc:123
zypp::media::TransferSettings::setUsername
void setUsername(std::string &&val_r)
sets the auth username
Definition: TransferSettings.cc:95
zypp::media::TransferSettings::setClientCertificatePath
void setClientCertificatePath(Pathname &&val_r)
Sets the SSL client certificate file.
Definition: TransferSettings.cc:215
zypp::media::TransferSettings::setHeadRequestsAllowed
void setHeadRequestsAllowed(bool allowed)
set whether HEAD requests are allowed
Definition: TransferSettings.cc:252
zypp::media::TransferSettings::headers
Headers headers() const
returns a list of all added headers
Definition: TransferSettings.cc:78
Url.h
zypp::media::TransferSettings::maxSilentTries
long maxSilentTries() const
Maximum silent retries.
Definition: TransferSettings.cc:197
zypp::media::TransferSettings::proxyUsername
std::string proxyUsername() const
proxy auth username
Definition: TransferSettings.cc:140
zypp::media::TransferSettings::setProxy
void setProxy(std::string &&val_r)
proxy to use if it is enabled
Definition: TransferSettings.cc:130
zypp::media::TransferSettings::Impl
Definition: TransferSettings.cc:24
zypp::media::TransferSettings::protoData
const zypp::proto::TransferSettings & protoData() const
Definition: TransferSettings.cc:233
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2
zypp::proto
Definition: TransferSettings.h:12
zypp::media::TransferSettings::userAgentString
std::string userAgentString() const
user agent string
Definition: TransferSettings.cc:91
zypp::media::TransferSettings::clientKeyPath
Pathname clientKeyPath() const
SSL client key file.
Definition: TransferSettings.cc:225
zypp::media::TransferSettings::clientCertificatePath
Pathname clientCertificatePath() const
SSL client certificate file.
Definition: TransferSettings.cc:218
zypp::media::TransferSettings::setVerifyPeerEnabled
void setVerifyPeerEnabled(bool enabled)
Sets whether to verify host for ssl.
Definition: TransferSettings.cc:208
zypp::media::TransferSettings::setMaxDownloadSpeed
void setMaxDownloadSpeed(long v)
Set max download speed (bytes per second)
Definition: TransferSettings.cc:187
zypp::media::TransferSettings::setProxyPassword
void setProxyPassword(std::string &&val_r)
sets the proxy password
Definition: TransferSettings.cc:143
zypp::media::TransferSettings::TransferSettings
TransferSettings()
Constructs a transfer program cmd line access.
Definition: TransferSettings.cc:61
zypp::media::TransferSettings::addHeader
void addHeader(std::string &&val_r)
add a header, on the form "Foo: Bar"
Definition: TransferSettings.cc:75
zypp::media::TransferSettings::Headers
std::vector< std::string > Headers
Definition: TransferSettings.h:32
zypp::media::TransferSettings::setAuthType
void setAuthType(std::string &&val_r)
set the allowed authentication types
Definition: TransferSettings.cc:245
zypp::filesystem::Pathname
Pathname.
Definition: Pathname.h:45
zypp::media::TransferSettings::setClientKeyPath
void setClientKeyPath(Pathname &&val_r)
Sets the SSL client key file.
Definition: TransferSettings.cc:222
zypp::media::TransferSettings::setPassword
void setPassword(std::string &&val_r)
sets the auth password
Definition: TransferSettings.cc:101
zypp::media::TransferSettings::setMinDownloadSpeed
void setMinDownloadSpeed(long v)
Set minimum download speed (bytes per second) until the connection is dropped.
Definition: TransferSettings.cc:180
zypp::media::TransferSettings::setProxyUsername
void setProxyUsername(std::string &&val_r)
sets the proxy user
Definition: TransferSettings.cc:137
zypp::media::TransferSettings::setCertificateAuthoritiesPath
void setCertificateAuthoritiesPath(Pathname &&val_r)
Sets the SSL certificate authorities path.
Definition: TransferSettings.cc:238
zypp::RWCOW_pointer< Impl >
zypp::media::TransferSettings::connectTimeout
long connectTimeout() const
connection timeout
Definition: TransferSettings.cc:169
Flags.h
zypp::media::TransferSettings::setUserAgentString
void setUserAgentString(std::string &&val_r)
sets the user agent ie: "Mozilla v3"
Definition: TransferSettings.cc:88
zypp::media::TransferSettings::setAnonymousAuth
void setAnonymousAuth()
sets anonymous authentication (ie: for ftp)
Definition: TransferSettings.cc:116
zypp::media::TransferSettings::proxy
std::string proxy() const
proxy host
Definition: TransferSettings.cc:133
zypp::media::TransferSettings::password
std::string password() const
auth password
Definition: TransferSettings.cc:104
zypp::media::TransferSettings::_impl
RWCOW_pointer< Impl > _impl
Definition: TransferSettings.h:194
zypp::media::TransferSettings::maxDownloadSpeed
long maxDownloadSpeed() const
Maximum download speed (bytes per second)
Definition: TransferSettings.cc:190