libcupt4-doc 2.9.9 / usr / share / doc / libcupt4-doc / html / classcupt_1_1download_1_1Method.html

This file is indexed.

/usr/share/doc/libcupt4-doc/html/classcupt_1_1download_1_1Method.html is in libcupt4-doc 2.9.9.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cupt: cupt::download::Method Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Cupt
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacecupt.html">cupt</a></li><li class="navelem"><a class="el" href="namespacecupt_1_1download.html">download</a></li><li class="navelem"><a class="el" href="classcupt_1_1download_1_1Method.html">Method</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="classcupt_1_1download_1_1Method-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cupt::download::Method Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>base class of download methods  
 <a href="classcupt_1_1download_1_1Method.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="method_8hpp_source.html">cupt/download/method.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae087508ec8f52aa38f5dceb9b898bf3c"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1download_1_1Method.html#ae087508ec8f52aa38f5dceb9b898bf3c">perform</a> (const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;config, const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;uri, const string &amp;targetPath, const std::function&lt; void(const vector&lt; string &gt; &amp;) &gt; &amp;callback)=0</td></tr>
<tr class="memdesc:ae087508ec8f52aa38f5dceb9b898bf3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">downloads <em>uri</em> to <em>targetPath</em>  <a href="#ae087508ec8f52aa38f5dceb9b898bf3c">More...</a><br /></td></tr>
<tr class="separator:ae087508ec8f52aa38f5dceb9b898bf3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a319a89faf8bab1ceebf7e34fdbe48f23"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1download_1_1Method.html#a319a89faf8bab1ceebf7e34fdbe48f23">getAcquireSuboptionForUri</a> (const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;config, const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;uri, const string &amp;suboptionName)</td></tr>
<tr class="memdesc:a319a89faf8bab1ceebf7e34fdbe48f23"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets URI-specific value of some <code>'acquire:</code>:*' option  <a href="#a319a89faf8bab1ceebf7e34fdbe48f23">More...</a><br /></td></tr>
<tr class="separator:a319a89faf8bab1ceebf7e34fdbe48f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7c4aa4d37c1a5f93935974d720b265c"><td class="memItemLeft" align="right" valign="top">static ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcupt_1_1download_1_1Method.html#aa7c4aa4d37c1a5f93935974d720b265c">getIntegerAcquireSuboptionForUri</a> (const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;config, const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;uri, const string &amp;suboptionName)</td></tr>
<tr class="memdesc:aa7c4aa4d37c1a5f93935974d720b265c"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets URI-specific value of some integer <code>'acquire:</code>:*' option  <a href="#aa7c4aa4d37c1a5f93935974d720b265c">More...</a><br /></td></tr>
<tr class="separator:aa7c4aa4d37c1a5f93935974d720b265c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>base class of download methods </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a319a89faf8bab1ceebf7e34fdbe48f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a319a89faf8bab1ceebf7e34fdbe48f23">&sect;&nbsp;</a></span>getAcquireSuboptionForUri()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static string cupt::download::Method::getAcquireSuboptionForUri </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;&#160;</td>
          <td class="paramname"><em>uri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>suboptionName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>gets URI-specific value of some <code>'acquire:</code>:*' option </p>
<p>Options of <code>Acquire</code> group can be overridden for specific host. This function hides the details and provides the convenient way get the value of the option in <code>Acquire</code> group for certain URI.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td></td></tr>
    <tr><td class="paramname">uri</td><td></td></tr>
    <tr><td class="paramname">suboptionName</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Example:</dt><dd><div class="fragment"><div class="line"><span class="keyword">auto</span> proxy = <a class="code" href="classcupt_1_1download_1_1Method.html#a319a89faf8bab1ceebf7e34fdbe48f23">getAcquireSuboptionForUri</a>(config, uri, <span class="stringliteral">&quot;proxy&quot;</span>);</div></div><!-- fragment --> </dd></dl>

</div>
</div>
<a id="aa7c4aa4d37c1a5f93935974d720b265c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7c4aa4d37c1a5f93935974d720b265c">&sect;&nbsp;</a></span>getIntegerAcquireSuboptionForUri()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static ssize_t cupt::download::Method::getIntegerAcquireSuboptionForUri </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;&#160;</td>
          <td class="paramname"><em>uri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>suboptionName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>gets URI-specific value of some integer <code>'acquire:</code>:*' option </p>
<p>Same as <a class="el" href="classcupt_1_1download_1_1Method.html#a319a89faf8bab1ceebf7e34fdbe48f23">getAcquireSuboptionForUri</a>, but for integer options.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td></td></tr>
    <tr><td class="paramname">uri</td><td></td></tr>
    <tr><td class="paramname">suboptionName</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ae087508ec8f52aa38f5dceb9b898bf3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae087508ec8f52aa38f5dceb9b898bf3c">&sect;&nbsp;</a></span>perform()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual string cupt::download::Method::perform </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1Config.html">Config</a> &amp;&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcupt_1_1download_1_1Uri.html">Uri</a> &amp;&#160;</td>
          <td class="paramname"><em>uri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>targetPath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::function&lt; void(const vector&lt; string &gt; &amp;) &gt; &amp;&#160;</td>
          <td class="paramname"><em>callback</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>downloads <em>uri</em> to <em>targetPath</em> </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">config</td><td></td></tr>
    <tr><td class="paramname">uri</td><td></td></tr>
    <tr><td class="paramname">targetPath</td><td>path to download to </td></tr>
    <tr><td class="paramname">callback</td><td>callback function</td></tr>
  </table>
  </dd>
</dl>
<dl class="section user"><dt>Allowed callback sequences:</dt><dd><code>downloading</code> <em>total_downloaded_bytes</em> <em>size_of_last_fetched_piece</em> <br />
<code>expected-size</code> <em>expected_file_size</em> </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cupt/download/<a class="el" href="method_8hpp_source.html">method.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.