apt  0.9.7.9
Public Member Functions | Protected Types | Protected Attributes | List of all members
pkgAcqIndexDiffs Class Reference

An item that is responsible for fetching all the patches {{{ that need to be applied to a given package index file. More...

#include <acquire-item.h>

Inheritance diagram for pkgAcqIndexDiffs:
pkgAcquire::Item WeakPointable

Public Member Functions

virtual void Failed (std::string Message, pkgAcquire::MethodConfig *Cnf)
 Called when the patch file failed to be downloaded.
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 DescURI ()
 A "descriptive" URI-like string.
 pkgAcqIndexDiffs (pkgAcquire *Owner, std::string URI, std::string URIDesc, std::string ShortDesc, HashString ExpectedHash, std::string ServerSha1, std::vector< DiffInfo > diffs=std::vector< DiffInfo >())
 Create an index diff item.
- 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.
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.
pkgAcquireGetOwner ()
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.
- Public Member Functions inherited from WeakPointable
void AddWeakPointer (WeakPointable **weakptr)
void RemoveWeakPointer (WeakPointable **weakptr)
 ~WeakPointable ()

Protected Types

enum  DiffState { StateFetchUnkown, StateFetchDiff, StateUnzipDiff, StateApplyDiff }

Protected Attributes

bool Debug
 If true, debugging output will be written to std::clog.
pkgAcquire::ItemDesc Desc
 A description of the item that is currently being downloaded.
std::string RealURI
 The URI of the package index file that is being reconstructed.
HashString ExpectedHash
 The HashSum of the package index file that is being reconstructed.
std::string Description
std::vector< DiffInfoavailable_patches
std::string ServerSha1
enum pkgAcqIndexDiffs::DiffState State
- 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.
- 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.

Detailed Description

An item that is responsible for fetching all the patches {{{ that need to be applied to a given package index file.

After downloading and applying a single patch, this item will enqueue a new pkgAcqIndexDiffs to download and apply the remaining patches. If no patch can be found that applies to an intermediate file or if one of the patches cannot be downloaded, falls back to downloading the entire package index file using pkgAcqIndex.

See Also
pkgAcqDiffIndex, pkgAcqIndex

Member Enumeration Documentation

enum DiffState
protected

The current status of this patch.

Enumerator:
StateFetchUnkown 

The diff is in an unknown state.

StateFetchDiff 

The diff is currently being fetched.

StateUnzipDiff 

The diff is currently being uncompressed.

StateApplyDiff 

The diff is currently being applied.

Constructor & Destructor Documentation

pkgAcqIndexDiffs ( pkgAcquire Owner,
std::string  URI,
std::string  URIDesc,
std::string  ShortDesc,
HashString  ExpectedHash,
std::string  ServerSha1,
std::vector< DiffInfo diffs = std::vector<DiffInfo>() 
)

Create an index diff item.

After filling in its basic fields, this invokes Finish(true) if #diffs is empty, or QueueNextDiff() otherwise.

Parameters
OwnerThe pkgAcquire object that owns this item.
URIThe URI of the package index file being reconstructed.
URIDescA long description of this item.
ShortDescA brief description of this item.
ExpectedHashThe expected md5sum of the completely reconstructed package index file; the index file will be tested against this value when it is entirely reconstructed.
diffsThe remaining diffs from the index of diffs. They should be ordered so that each diff appears before any diff that depends on it.

References available_patches, Debug, Desc, Description, pkgAcquire::Item::DestFile, pkgAcquire::ItemDesc::Owner, pkgAcquire::Item::ShortDesc(), pkgAcquire::ItemDesc::ShortDesc, and StateFetchDiff.

Referenced by Done().

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 RealURI.

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 available_patches, Debug, Desc, Description, pkgAcquire::Item::DestFile, ExpectedHash, pkgAcquire::Item::Local, pkgAcquire::Item::Mode, pkgAcquire::Item::Owner, pkgAcqIndexDiffs(), pkgAcquire::Item::QueueURI(), RealURI, pkgAcquire::Item::Rename(), ServerSha1, pkgAcquire::ItemDesc::ShortDesc, StateApplyDiff, StateFetchDiff, and pkgAcquire::ItemDesc::URI.

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

Called when the patch file failed to be downloaded.

This method will fall back to downloading the whole index file outright; its arguments are ignored.

Reimplemented from pkgAcquire::Item.

References Debug, Desc, Description, ExpectedHash, pkgAcquire::Item::Owner, RealURI, pkgAcquire::ItemDesc::ShortDesc, and pkgAcquire::ItemDesc::URI.

Member Data Documentation

std::vector<DiffInfo> available_patches
protected

The patches that remain to be downloaded, including the patch being downloaded right now. This list should be ordered so that each diff appears before any diff that depends on it.

Todo:
These are indexed by sha1sum; why not use some sort of dictionary instead of relying on ordering and stripping them off the front?

Referenced by Done(), and pkgAcqIndexDiffs().

std::string Description
protected

A description of the file being downloaded.

Referenced by Done(), Failed(), and pkgAcqIndexDiffs().

std::string ServerSha1
protected

Stop applying patches when reaching that sha1

Referenced by Done().


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