apt  1.5
Public Member Functions | Protected Attributes
pkgAcqIndex Class Reference

An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources). More...

#include <acquire-item.h>

Inheritance diagram for pkgAcqIndex:
Inheritance graph
[legend]
Collaboration diagram for pkgAcqIndex:
Collaboration graph
[legend]

List of all members.

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)

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").

Detailed Description

An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources).

See also:
pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
Todo:
Why does pkgAcqIndex have protected members?

Constructor & Destructor Documentation

pkgAcqIndex ( pkgAcquire Owner,
std::string  URI,
std::string  URIDesc,
std::string  ShortDesc,
HashString  ExpectedHash,
std::string  compressExt = "" 
)

Create a pkgAcqIndex.

Parameters:
OwnerThe pkgAcquire object with which this item is associated.
URIThe URI of the index file that is to be downloaded.
URIDescA "URI-style" description of this index file.
ShortDescA brief description of this index file.
ExpectedHashThe expected hashsum of this index file.
compressExtThe 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().


Member Function Documentation

string Custom600Headers ( ) [virtual]

Custom headers to be sent to the fetch process.

Returns:
a string containing RFC822-style headers that are to be inserted into the 600 URI Acquire message sent to the fetch subprocess. The headers are inserted after a newline-less line, so they should (if nonempty) have a leading newline and no trailing newline.

Reimplemented from pkgAcquire::Item.

Reimplemented in pkgAcqIndexTrans.

References RealURI, and pkgAcquire::Item::ShortDesc().

virtual std::string DescURI ( ) [inline, virtual]

A "descriptive" URI-like string.

Returns:
a URI that should be used to describe what is being fetched.

Implements pkgAcquire::Item.

References Desc, and pkgAcquire::ItemDesc::URI.

void Done ( std::string  Message,
unsigned long long  Size,
std::string  Hash,
pkgAcquire::MethodConfig Cnf 
) [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.

Parameters:
MessageData from the acquire method. Use LookupTag() to parse it.
SizeThe size of the object that was fetched.
HashThe HashSum of the object that was fetched.
CnfThe method via which the object was fetched.
See also:
pkgAcqMethod

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.

void Failed ( std::string  Message,
pkgAcquire::MethodConfig Cnf 
) [virtual]

Invoked by the acquire worker when the object couldn't be fetched.

This is a branch of the continuation of the fetch process.

Parameters:
MessageAn RFC822-formatted message from the acquire method describing what went wrong. Use LookupTag() to parse it.
CnfThe method via which the worker tried to fetch this object.
See also:
pkgAcqMethod

Reimplemented from pkgAcquire::Item.

Reimplemented in pkgAcqIndexTrans.

References CompressionExtension, Decompression, Desc, pkgAcquire::ItemDesc::Description, Erase, RealURI, and pkgAcquire::ItemDesc::ShortDesc.

virtual std::string HashSum ( ) [inline, virtual]

HashSum.

Returns:
the HashSum of this object, if applicable; otherwise, an empty string.

Reimplemented from pkgAcquire::Item.

References ExpectedHash.


Member Data Documentation

bool Verify [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().


The documentation for this class was generated from the following files: