apt
0.9.6ubuntu1
|
An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources). More...
#include <acquire-item.h>
Public Member Functions | |
virtual void | Failed (std::string Message, pkgAcquire::MethodConfig *Cnf) |
Invoked by the acquire worker when the object couldn't be fetched. | |
virtual void | Done (std::string Message, unsigned long long Size, std::string Md5Hash, pkgAcquire::MethodConfig *Cnf) |
Invoked by the acquire worker when the object was fetched successfully. | |
virtual std::string | Custom600Headers () |
Custom headers to be sent to the fetch process. | |
virtual std::string | DescURI () |
A "descriptive" URI-like string. | |
virtual std::string | HashSum () |
HashSum. | |
pkgAcqIndex (pkgAcquire *Owner, std::string URI, std::string URIDesc, std::string ShortDesc, HashString ExpectedHash, std::string compressExt="") | |
Create a pkgAcqIndex. | |
pkgAcqIndex (pkgAcquire *Owner, struct IndexTarget const *const Target, HashString const &ExpectedHash, indexRecords const *MetaIndexParser) | |
void | Init (std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc) |
![]() | |
virtual void | Start (std::string Message, unsigned long long Size) |
Invoked when the worker starts to fetch this object. | |
virtual std::string | ShortDesc () |
Short item description. | |
virtual void | Finished () |
Invoked by the worker when the download is completely done. | |
pkgAcquire * | GetOwner () |
virtual bool | IsTrusted () |
void | ReportMirrorFailure (std::string FailCode) |
Report mirror problem. | |
Item (pkgAcquire *Owner) | |
Initialize an item. | |
virtual | ~Item () |
Remove this item from its owner's queue by invoking pkgAcquire::Remove. | |
![]() | |
void | AddWeakPointer (WeakPointable **weakptr) |
void | RemoveWeakPointer (WeakPointable **weakptr) |
~WeakPointable () |
Protected Attributes | |
bool | Decompression |
If true, the index file has been decompressed. | |
bool | Erase |
If true, the partially downloaded file will be removed when the download completes. | |
bool | Verify |
Verify for correctness by checking if a "Package" tag is found in the index. This can be set to false for optional index targets. | |
pkgAcquire::ItemDesc | Desc |
The download request that is currently being processed. | |
std::string | RealURI |
The object that is actually being fetched (minus any compression-related extensions). | |
HashString | ExpectedHash |
The expected hashsum of the decompressed index file. | |
std::string | CompressionExtension |
The compression-related file extensions that are being added to the downloaded file one by one if first fails (e.g., "gz bz2"). | |
![]() | |
pkgAcquire * | Owner |
The acquire object with which this item is associated. |
Additional Inherited Members | |
![]() | |
enum | ItemState { StatIdle, StatFetching, StatDone, StatError, StatAuthError, StatTransientNetworkError } |
The current status of this item. More... | |
![]() | |
enum pkgAcquire::Item::ItemState | Status |
std::string | ErrorText |
Contains a textual description of the error encountered if #Status is StatError or StatAuthError. | |
unsigned long long | FileSize |
The size of the object to fetch. | |
unsigned long long | PartialSize |
How much of the object was already fetched. | |
const char * | Mode |
If not NULL, contains the name of a subprocess that is operating on this object (for instance, "gzip" or "gpgv"). | |
unsigned long | ID |
A client-supplied unique identifier. | |
bool | Complete |
If true, the entire object has been successfully fetched. | |
bool | Local |
If true, the URI of this object is "local". | |
std::string | UsedMirror |
unsigned int | QueueCounter |
The number of fetch queues into which this item has been inserted. | |
std::string | DestFile |
The name of the file into which the retrieved object will be written. | |
![]() | |
void | QueueURI (ItemDesc &Item) |
Insert this item into its owner's queue. | |
void | Dequeue () |
Remove this item from its owner's queue. | |
void | Rename (std::string From, std::string To) |
Rename a file without modifying its timestamp. |
An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources).
pkgAcqIndex | ( | pkgAcquire * | Owner, |
std::string | URI, | ||
std::string | URIDesc, | ||
std::string | ShortDesc, | ||
HashString | ExpectedHash, | ||
std::string | compressExt = "" |
||
) |
Create a pkgAcqIndex.
Owner | The pkgAcquire object with which this item is associated. |
URI | The URI of the index file that is to be downloaded. |
URIDesc | A "URI-style" description of this index file. |
ShortDesc | A brief description of this index file. |
ExpectedHash | The expected hashsum of this index file. |
compressExt | The compression-related extension with which this index file should be downloaded, or "" to autodetect Compression types can be set with config Acquire::CompressionTypes, default is ".lzma" or ".bz2" (if the needed binaries are present) fallback is ".gz" or none. |
References CompressionExtension, and Configuration::getCompressionTypes().
|
virtual |
Custom headers to be sent to the fetch process.
Reimplemented from pkgAcquire::Item.
Reimplemented in pkgAcqIndexTrans.
References RealURI, and pkgAcquire::Item::ShortDesc().
|
inlinevirtual |
A "descriptive" URI-like string.
Implements pkgAcquire::Item.
References Desc, and pkgAcquire::ItemDesc::URI.
|
virtual |
Invoked by the acquire worker when the object was fetched successfully.
Note that the object might not have been written to DestFile; check for the presence of an Alt-Filename entry in Message to find the file to which it was really written.
Done is often used to switch from one stage of the processing to the next (e.g. fetching, unpacking, copying). It is one branch of the continuation of the fetch process.
Message | Data from the acquire method. Use LookupTag() to parse it. |
Size | The size of the object that was fetched. |
Hash | The HashSum of the object that was fetched. |
Cnf | The method via which the object was fetched. |
Reimplemented from pkgAcquire::Item.
References pkgAcquire::Item::Complete, CompressionExtension, Decompression, Desc, pkgAcquire::Item::DestFile, Erase, pkgAcquire::Item::ErrorText, pkgAcquire::Item::Local, pkgAcquire::Item::Mode, pkgAcquire::Item::QueueURI(), RealURI, pkgAcquire::Item::Rename(), pkgAcquire::Item::ReportMirrorFailure(), pkgAcquire::Item::StatAuthError, pkgAcquire::Item::StatError, pkgAcquire::ItemDesc::URI, and Verify.
|
virtual |
Invoked by the acquire worker when the object couldn't be fetched.
This is a branch of the continuation of the fetch process.
Message | An RFC822-formatted message from the acquire method describing what went wrong. Use LookupTag() to parse it. |
Cnf | The method via which the worker tried to fetch this object. |
Reimplemented from pkgAcquire::Item.
Reimplemented in pkgAcqIndexTrans.
References CompressionExtension, Decompression, Desc, pkgAcquire::ItemDesc::Description, Erase, RealURI, and pkgAcquire::ItemDesc::ShortDesc.
|
inlinevirtual |
HashSum.
Reimplemented from pkgAcquire::Item.
References ExpectedHash.
|
protected |
Verify for correctness by checking if a "Package" tag is found in the index. This can be set to false for optional index targets.
Referenced by Done().