Public Member Functions | Protected Member Functions | Protected Attributes

pkgAcqArchive Class Reference
[Acquire system {{{]

An item that is responsible for fetching a package file. {{{. More...

#include <acquire-item.h>

Inheritance diagram for pkgAcqArchive:
pkgAcquire::Item WeakPointable

List of all members.

Public Member Functions

virtual void Failed (string Message, pkgAcquire::MethodConfig *Cnf)
 Invoked by the acquire worker when the object couldn't be fetched.
virtual void Done (string Message, unsigned long Size, string Hash, pkgAcquire::MethodConfig *Cnf)
 Invoked by the acquire worker when the object was fetched successfully.
virtual string DescURI ()
 A "descriptive" URI-like string.
virtual string ShortDesc ()
 Short item description.
virtual void Finished ()
 Invoked by the worker when the download is completely done.
virtual string HashSum ()
 HashSum.
virtual bool IsTrusted ()
 pkgAcqArchive (pkgAcquire *Owner, pkgSourceList *Sources, pkgRecords *Recs, pkgCache::VerIterator const &Version, string &StoreFilename)
 Create a new pkgAcqArchive.

Protected Member Functions

bool QueueNext ()
 Queue up the next available file for this version.

Protected Attributes

pkgCache::VerIterator Version
 The package version being fetched.
pkgAcquire::ItemDesc Desc
 The fetch command that is currently being processed.
pkgSourceListSources
 The list of sources from which to pick archives to download this package from.
pkgRecordsRecs
 A package records object, used to look up the file corresponding to each version of the package.
HashString ExpectedHash
 The hashsum of this package.
string & StoreFilename
 A location in which the actual filename of the package should be stored.
pkgCache::VerFileIterator Vf
 The next file for this version to try to download.
unsigned int Retries
 How many (more) times to try to find a new source from which to download this package version if it fails.
bool Trusted
 true if this version file is being downloaded from a trusted source.

Detailed Description

An item that is responsible for fetching a package file. {{{.

If the package file already exists in the cache, nothing will be done.


Constructor & Destructor Documentation

pkgAcqArchive ( pkgAcquire Owner,
pkgSourceList Sources,
pkgRecords Recs,
pkgCache::VerIterator const &  Version,
string &  StoreFilename 
)

Create a new pkgAcqArchive.

Parameters:
Owner The pkgAcquire object with which this item is associated.
Sources The sources from which to download version files.
Recs A package records object, used to look up the file corresponding to each version of the package.
Version The package version to download.
StoreFilename A location in which the actual filename of the package should be stored. It will be set to a guessed basename in the constructor, and filled in with a fully qualified filename once the download finishes.

References QueueNext(), Retries, Trusted, and Vf.


Member Function Documentation

virtual 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 ( string  Message,
unsigned long  Size,
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:
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.
See also:
pkgAcqMethod

Reimplemented from pkgAcquire::Item.

References pkgAcquire::Item::Complete, pkgAcquire::Item::DestFile, pkgAcquire::Item::ErrorText, ExpectedHash, pkgAcquire::Item::Local, pkgAcquire::Item::Rename(), pkgAcquire::Item::Status, StoreFilename, and Version.

void Failed ( 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:
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.
See also:
pkgAcqMethod

Reimplemented from pkgAcquire::Item.

References pkgAcquire::Item::ErrorText, pkgAcquire::MethodConfig::LocalOnly, QueueNext(), pkgAcquire::MethodConfig::Removable, Retries, StoreFilename, Version, and Vf.

virtual string HashSum (  )  [inline, virtual]

HashSum.

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

Reimplemented from pkgAcquire::Item.

References ExpectedHash.

bool IsTrusted (  )  [virtual]
Returns:
true if this object is being fetched from a trusted source.

Reimplemented from pkgAcquire::Item.

References Trusted.

virtual string ShortDesc (  )  [inline, virtual]

Short item description.

Returns:
a brief description of the object being fetched.

Reimplemented from pkgAcquire::Item.

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


Member Data Documentation

unsigned int Retries [protected]

How many (more) times to try to find a new source from which to download this package version if it fails.

Set from Acquire::Retries.

Referenced by Failed(), and pkgAcqArchive().


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