<!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: pkgAcquire::MethodConfig Struct 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">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="classpkgAcquire.xhtml">pkgAcquire</a></li><li class="navelem"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml">MethodConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structpkgAcquire_1_1MethodConfig-members.xhtml">List of all members</a> </div>
<div class="headertitle">
<div class="title">pkgAcquire::MethodConfig Struct Reference<div class="ingroups"><a class="el" href="group__acquire.xhtml">Acquire system {{{</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Information about the properties of a single acquire method. {{{.
<a href="structpkgAcquire_1_1MethodConfig.xhtml#details">More...</a></p>
<p><code>#include <<a class="el" href="acquire_8h_source.xhtml">apt-pkg/acquire.h</a>></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:a29c0cb60fa0c1e5f67d911bed92f2006"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a29c0cb60fa0c1e5f67d911bed92f2006">MethodConfig</a> ()</td></tr>
<tr class="memdesc:a29c0cb60fa0c1e5f67d911bed92f2006"><td class="mdescLeft"> </td><td class="mdescRight">Set up the default method parameters. <a href="#a29c0cb60fa0c1e5f67d911bed92f2006">More...</a><br /></td></tr>
<tr class="separator:a29c0cb60fa0c1e5f67d911bed92f2006"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:adefdaa851eb40c6d5949d65431639cbb"><td class="memItemLeft" align="right" valign="top"><a id="adefdaa851eb40c6d5949d65431639cbb"></a>
void *const </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#adefdaa851eb40c6d5949d65431639cbb">d</a></td></tr>
<tr class="memdesc:adefdaa851eb40c6d5949d65431639cbb"><td class="mdescLeft"> </td><td class="mdescRight">dpointer placeholder (for later in case we need it) <br /></td></tr>
<tr class="separator:adefdaa851eb40c6d5949d65431639cbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add1daf6c866236479bdac390ed41f80a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml">MethodConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#add1daf6c866236479bdac390ed41f80a">Next</a></td></tr>
<tr class="memdesc:add1daf6c866236479bdac390ed41f80a"><td class="mdescLeft"> </td><td class="mdescRight">The next link on the acquire method list. <a href="#add1daf6c866236479bdac390ed41f80a">More...</a><br /></td></tr>
<tr class="separator:add1daf6c866236479bdac390ed41f80a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a006a979c4801f6b6ceb33cb3acd6dc89"><td class="memItemLeft" align="right" valign="top"><a id="a006a979c4801f6b6ceb33cb3acd6dc89"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a006a979c4801f6b6ceb33cb3acd6dc89">Access</a></td></tr>
<tr class="memdesc:a006a979c4801f6b6ceb33cb3acd6dc89"><td class="mdescLeft"> </td><td class="mdescRight">The name of this acquire method (e.g., http). <br /></td></tr>
<tr class="separator:a006a979c4801f6b6ceb33cb3acd6dc89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9128f413b7890b2493b88f88fe258259"><td class="memItemLeft" align="right" valign="top"><a id="a9128f413b7890b2493b88f88fe258259"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a9128f413b7890b2493b88f88fe258259">Version</a></td></tr>
<tr class="memdesc:a9128f413b7890b2493b88f88fe258259"><td class="mdescLeft"> </td><td class="mdescRight">The implementation version of this acquire method. <br /></td></tr>
<tr class="separator:a9128f413b7890b2493b88f88fe258259"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a73e5dd8b9abd83a562ded9c050af4fc5"><td class="memItemLeft" align="right" valign="top"><a id="a73e5dd8b9abd83a562ded9c050af4fc5"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a73e5dd8b9abd83a562ded9c050af4fc5">SingleInstance</a></td></tr>
<tr class="memdesc:a73e5dd8b9abd83a562ded9c050af4fc5"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, only one download queue should be created for this method. <br /></td></tr>
<tr class="separator:a73e5dd8b9abd83a562ded9c050af4fc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a184f137ba7f14f7867d1480d05645973"><td class="memItemLeft" align="right" valign="top"><a id="a184f137ba7f14f7867d1480d05645973"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a184f137ba7f14f7867d1480d05645973">Pipeline</a></td></tr>
<tr class="memdesc:a184f137ba7f14f7867d1480d05645973"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, this method supports pipelined downloading. <br /></td></tr>
<tr class="separator:a184f137ba7f14f7867d1480d05645973"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb5234a93cf150f464001a2768eb7b27"><td class="memItemLeft" align="right" valign="top"><a id="aeb5234a93cf150f464001a2768eb7b27"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#aeb5234a93cf150f464001a2768eb7b27">SendConfig</a></td></tr>
<tr class="memdesc:aeb5234a93cf150f464001a2768eb7b27"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, the worker process should send the entire APT configuration tree to the fetch subprocess when it starts up. <br /></td></tr>
<tr class="separator:aeb5234a93cf150f464001a2768eb7b27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8b6e3669e200451d5531db670a0b7be8"><td class="memItemLeft" align="right" valign="top"><a id="a8b6e3669e200451d5531db670a0b7be8"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a8b6e3669e200451d5531db670a0b7be8">LocalOnly</a></td></tr>
<tr class="memdesc:a8b6e3669e200451d5531db670a0b7be8"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, this fetch method does not require network access; all files are to be acquired from the local disk. <br /></td></tr>
<tr class="separator:a8b6e3669e200451d5531db670a0b7be8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18ab15b6a105e10118c35973765cce34"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a18ab15b6a105e10118c35973765cce34">NeedsCleanup</a></td></tr>
<tr class="memdesc:a18ab15b6a105e10118c35973765cce34"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, the subprocess has to carry out some cleanup actions before shutting down. <a href="#a18ab15b6a105e10118c35973765cce34">More...</a><br /></td></tr>
<tr class="separator:a18ab15b6a105e10118c35973765cce34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a871cd013ae63d288941eb4bc3db93ae7"><td class="memItemLeft" align="right" valign="top"><a id="a871cd013ae63d288941eb4bc3db93ae7"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml#a871cd013ae63d288941eb4bc3db93ae7">Removable</a></td></tr>
<tr class="memdesc:a871cd013ae63d288941eb4bc3db93ae7"><td class="mdescLeft"> </td><td class="mdescRight">If <b>true</b>, this fetch method acquires files from removable media. <br /></td></tr>
<tr class="separator:a871cd013ae63d288941eb4bc3db93ae7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information about the properties of a single acquire method. {{{. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a29c0cb60fa0c1e5f67d911bed92f2006"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29c0cb60fa0c1e5f67d911bed92f2006">◆ </a></span>MethodConfig()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml">MethodConfig</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up the default method parameters. </p>
<p>All fields are initialized to NULL, "", or <b>false</b> as appropriate. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a18ab15b6a105e10118c35973765cce34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18ab15b6a105e10118c35973765cce34">◆ </a></span>NeedsCleanup</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NeedsCleanup</td>
</tr>
</table>
</div><div class="memdoc">
<p>If <b>true</b>, the subprocess has to carry out some cleanup actions before shutting down. </p>
<p>For instance, the cdrom method needs to unmount the CD after it finishes. </p>
<p class="reference">Referenced by <a class="el" href="classpkgAcquire_1_1Worker.xhtml#aa3de23b9c5a564121a667dd9b392e158">pkgAcquire::Worker::Capabilities()</a>, <a class="el" href="classpkgAcquire_1_1Queue.xhtml#a0483a6e5db0c15e5445bcc6a00262204">pkgAcquire::Queue::Shutdown()</a>, and <a class="el" href="classpkgAcquire_1_1Worker.xhtml#a6c90b9d499e906079194f681b6cb90ca">pkgAcquire::Worker::~Worker()</a>.</p>
</div>
</div>
<a id="add1daf6c866236479bdac390ed41f80a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add1daf6c866236479bdac390ed41f80a">◆ </a></span>Next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpkgAcquire_1_1MethodConfig.xhtml">MethodConfig</a>* Next</td>
</tr>
</table>
</div><div class="memdoc">
<p>The next link on the acquire method list. </p>
<dl class="todo"><dt><b><a class="el" href="todo.xhtml#_todo000027">Todo:</a></b></dt><dd>Why not an STL container? </dd></dl>
<p class="reference">Referenced by <a class="el" href="classpkgAcquire.xhtml#ad698ed345d50318b53f3cc3ae43190db">pkgAcquire::GetConfig()</a>, and <a class="el" href="classpkgAcquire.xhtml#a63b3097945b28966895045ffeaeb658c">pkgAcquire::~pkgAcquire()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>apt-pkg/<a class="el" href="acquire_8h_source.xhtml">acquire.h</a></li>
<li>apt-pkg/acquire.cc</li>
</ul>
</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>
