<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>apt: apt-pkg/acquire-method.h Source File</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">apt
 <span id="projectnumber">1.4.6</span>
</div>
<div id="projectbrief">commandline package manager</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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="dir_18f22d4be2ca84c350e120b6506056ca.xhtml">apt-pkg</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">acquire-method.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="acquire-method_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// -*- mode: cpp; mode: fold -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Description /*{{{*/</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/* ######################################################################</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> Acquire Method - Method helper class + functions</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> </span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> These functions are designed to be used within the method task to</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> ease communication with APT.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> ##################################################################### */</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <span class="comment">/*}}}*/</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef PKGLIB_ACQUIRE_METHOD_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define PKGLIB_ACQUIRE_METHOD_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <apt-pkg/hashes.h></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <apt-pkg/macros.h></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <stdarg.h></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <time.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#ifndef APT_8_CLEANER_HEADERS</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include <apt-pkg/configuration.h></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <apt-pkg/strutl.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classpkgAcqMethod.xhtml"> 36</a></span> <span class="keyword">class </span><a class="code" href="classpkgAcqMethod.xhtml">pkgAcqMethod</a></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structpkgAcqMethod_1_1FetchItem.xhtml"> 40</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a> *Next;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::string Uri;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  std::string DestFile;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">int</span> DestFileFd;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  time_t LastModified;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> IndexFile;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">bool</span> FailIgnore;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="classHashStringList.xhtml">HashStringList</a> ExpectedHashes;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// a maximum size we will download, this can be the exact filesize</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// for when we know it or a arbitrary limit when we don't know the</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// filesize (like a InRelease file)</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> MaximumSize;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a>();</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> ~<a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a>();</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structpkgAcqMethod_1_1FetchResult.xhtml"> 62</a></span>  <span class="keyword">struct </span><a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classHashStringList.xhtml">HashStringList</a> <a class="code" href="classHashes.xhtml">Hashes</a>;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::vector<std::string> GPGVOutput;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  time_t LastModified;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">bool</span> IMSHit;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  std::string Filename;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> Size;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> ResumePoint;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> TakeHashes(<span class="keyword">class</span> Hashes &Hash);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a>();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">virtual</span> ~<a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a>();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> * <span class="keyword">const</span> d;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  };</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// State</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  std::vector<std::string> Messages;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a> *Queue;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a> *QueueBack;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::string FailReason;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::string UsedMirror;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::string IP;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// Handlers for messages</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classConfiguration.xhtml">Configuration</a>(std::string Message);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Fetch(<a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a> * <span class="comment">/*Item*/</span>) {<span class="keywordflow">return</span> <span class="keyword">true</span>;};</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> URIAcquire(std::string <span class="keyword">const</span> &<span class="comment">/*Message*/</span>, <a class="code" href="structpkgAcqMethod_1_1FetchItem.xhtml">FetchItem</a> *Itm) { <span class="keywordflow">return</span> Fetch(Itm); };</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// Outgoing messages</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> Fail(<span class="keywordtype">bool</span> Transient = <span class="keyword">false</span>);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> Fail(<span class="keyword">const</span> <span class="keywordtype">char</span> *Why, <span class="keywordtype">bool</span> Transient = <span class="keyword">false</span>) {Fail(std::string(Why),Transient);};</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Fail(std::string Why, <span class="keywordtype">bool</span> Transient = <span class="keyword">false</span>);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> URIStart(<a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a> &Res);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> URIDone(<a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a> &Res,<a class="code" href="structpkgAcqMethod_1_1FetchResult.xhtml">FetchResult</a> *Alt = 0);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">bool</span> MediaFail(std::string Required,std::string Drive);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Exit() {};</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> PrintStatus(<span class="keywordtype">char</span> <span class="keyword">const</span> * <span class="keyword">const</span> header, <span class="keyword">const</span> <span class="keywordtype">char</span>* Format, va_list &args) <span class="keyword">const</span>;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">enum</span> CnfFlags {SingleInstance = (1<<0),</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  Pipeline = (1<<1), SendConfig = (1<<2),</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  LocalOnly = (1<<3), NeedsCleanup = (1<<4), </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  Removable = (1<<5)};</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> Log(<span class="keyword">const</span> <span class="keywordtype">char</span> *Format,...);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">void</span> Status(<span class="keyword">const</span> <span class="keywordtype">char</span> *Format,...);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> Redirect(<span class="keyword">const</span> std::string &NewURI);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">int</span> Run(<span class="keywordtype">bool</span> Single = <span class="keyword">false</span>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> SetFailReason(std::string Msg) {FailReason = Msg;};</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">inline</span> <span class="keywordtype">void</span> SetIP(std::string aIP) {IP = aIP;};</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="classpkgAcqMethod.xhtml">pkgAcqMethod</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *Ver,<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Flags = 0);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">virtual</span> ~<a class="code" href="classpkgAcqMethod.xhtml">pkgAcqMethod</a>();</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">void</span> DropPrivsOrDie();</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  APT_HIDDEN <span class="keywordtype">void</span> Dequeue();</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> };</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classHashStringList_xhtml"><div class="ttname"><a href="classHashStringList.xhtml">HashStringList</a></div><div class="ttdef"><b>Definition:</b> hashes.h:79</div></div>
<div class="ttc" id="classHashes_xhtml"><div class="ttname"><a href="classHashes.xhtml">Hashes</a></div><div class="ttdef"><b>Definition:</b> hashes.h:184</div></div>
<div class="ttc" id="structpkgAcqMethod_1_1FetchItem_xhtml"><div class="ttname"><a href="structpkgAcqMethod_1_1FetchItem.xhtml">pkgAcqMethod::FetchItem</a></div><div class="ttdef"><b>Definition:</b> acquire-method.h:40</div></div>
<div class="ttc" id="classConfiguration_xhtml"><div class="ttname"><a href="classConfiguration.xhtml">Configuration</a></div><div class="ttdef"><b>Definition:</b> configuration.h:43</div></div>
<div class="ttc" id="classpkgAcqMethod_xhtml"><div class="ttname"><a href="classpkgAcqMethod.xhtml">pkgAcqMethod</a></div><div class="ttdef"><b>Definition:</b> acquire-method.h:36</div></div>
<div class="ttc" id="structpkgAcqMethod_1_1FetchResult_xhtml"><div class="ttname"><a href="structpkgAcqMethod_1_1FetchResult.xhtml">pkgAcqMethod::FetchResult</a></div><div class="ttdef"><b>Definition:</b> acquire-method.h:62</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
