apt @VERSION@
|
Retrieve an arbitrary file to the current directory. {{{. More...
#include <acquire-item.h>
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 CalcHash, pkgAcquire::MethodConfig *Cnf) |
Invoked by the acquire worker when the object was fetched successfully. | |
virtual string | DescURI () |
A "descriptive" URI-like string. | |
virtual string | HashSum () |
HashSum. | |
virtual string | Custom600Headers () |
Custom headers to be sent to the fetch process. | |
pkgAcqFile (pkgAcquire *Owner, string URI, string Hash, unsigned long Size, string Desc, string ShortDesc, const string &DestDir="", const string &DestFilename="", bool IsIndexFile=false) | |
Create a new pkgAcqFile object. |
Retrieve an arbitrary file to the current directory. {{{.
The file is retrieved even if it is accessed via a URL type that normally is a NOP, such as "file". If the download fails, the partial file is renamed to get a ".FAILED" extension.
pkgAcqFile | ( | pkgAcquire * | Owner, |
string | URI, | ||
string | Hash, | ||
unsigned long | Size, | ||
string | Desc, | ||
string | ShortDesc, | ||
const string & | DestDir = "" , |
||
const string & | DestFilename = "" , |
||
bool | IsIndexFile = false |
||
) |
Create a new pkgAcqFile object.
Owner | The pkgAcquire object with which this object is associated. |
URI | The URI to download. |
Hash | The hashsum of the file to download, if it is known; otherwise "". |
Size | The size of the file to download, if it is known; otherwise 0. |
Desc | A description of the file being downloaded. |
ShortDesc | A brief description of the file being downloaded. |
DestDir | The directory the file should be downloaded into. |
DestFilename | The filename+path the file is downloaded to. |
IsIndexFile | The file is considered a IndexFile and cache-control headers like "cache-control: max-age=0" are send |
If DestFilename is empty, download to DestDir/<basename> if DestDir is non-empty, $CWD/<basename> otherwise. If DestFilename is NOT empty, DestDir is ignored and DestFilename is the absolute name to which the file should be downloaded.
References pkgAcquire::ItemDesc::Description, pkgAcquire::Item::FileSize, pkgAcquire::ItemDesc::Owner, pkgAcquire::Item::PartialSize, pkgAcquire::Item::QueueURI(), pkgAcquire::Item::ShortDesc(), pkgAcquire::ItemDesc::ShortDesc, and pkgAcquire::ItemDesc::URI.
string Custom600Headers | ( | ) | [virtual] |
Custom headers to be sent to the fetch process.
Reimplemented from pkgAcquire::Item.
virtual string DescURI | ( | ) | [inline, virtual] |
A "descriptive" URI-like string.
Implements pkgAcquire::Item.
References pkgAcquire::ItemDesc::URI.
virtual 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.
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.
virtual 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.
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.
virtual string HashSum | ( | ) | [inline, virtual] |
HashSum.
Reimplemented from pkgAcquire::Item.