apt  0.9.7.5ubuntu5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
pkgAcqArchive Class Reference

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

#include <acquire-item.h>

Inheritance diagram for pkgAcqArchive:
pkgAcquire::Item WeakPointable

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 Hash, pkgAcquire::MethodConfig *Cnf)
 Invoked by the acquire worker when the object was fetched successfully.
virtual std::string DescURI ()
 A "descriptive" URI-like string.
virtual std::string ShortDesc ()
 Short item description.
virtual void Finished ()
 Invoked by the worker when the download is completely done.
virtual std::string HashSum ()
 HashSum.
virtual bool IsTrusted ()
 pkgAcqArchive (pkgAcquire *Owner, pkgSourceList *Sources, pkgRecords *Recs, pkgCache::VerIterator const &Version, std::string &StoreFilename)
 Create a new pkgAcqArchive.
- Public Member Functions inherited from pkgAcquire::Item
virtual void Start (std::string Message, unsigned long long Size)
 Invoked when the worker starts to fetch this object.
virtual std::string Custom600Headers ()
 Custom headers to be sent to the fetch process.
pkgAcquireGetOwner ()
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.
- Public Member Functions inherited from WeakPointable
void AddWeakPointer (WeakPointable **weakptr)
void RemoveWeakPointer (WeakPointable **weakptr)
 ~WeakPointable ()

Protected Member Functions

bool QueueNext ()
 Queue up the next available file for this version.
- Protected Member Functions inherited from pkgAcquire::Item
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.

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.
std::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.
- Protected Attributes inherited from pkgAcquire::Item
pkgAcquireOwner
 The acquire object with which this item is associated.

Additional Inherited Members

- Public Types inherited from pkgAcquire::Item
enum  ItemState {
  StatIdle, StatFetching, StatDone, StatError,
  StatAuthError, StatTransientNetworkError
}
 The current status of this item. More...
- Public Attributes inherited from pkgAcquire::Item
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.

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,
std::string &  StoreFilename 
)

Create a new pkgAcqArchive.

Parameters
OwnerThe pkgAcquire object with which this item is associated.
SourcesThe sources from which to download version files.
RecsA package records object, used to look up the file corresponding to each version of the package.
VersionThe package version to download.
StoreFilenameA 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 std::string DescURI ( )
inlinevirtual

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, pkgAcquire::Item::DestFile, pkgAcquire::Item::ErrorText, pkgAcquire::Item::Local, pkgAcquire::Item::Rename(), pkgAcquire::Item::StatError, StoreFilename, and Version.

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.

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

virtual std::string HashSum ( )
inlinevirtual

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 std::string ShortDesc ( )
inlinevirtual

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: