apt
0.9.7.5ubuntu5
|
Retrieve an arbitrary file to the current directory. {{{. More...
#include <acquire-item.h>
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 CalcHash, 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 | HashSum () |
HashSum. | |
virtual std::string | Custom600Headers () |
Custom headers to be sent to the fetch process. | |
pkgAcqFile (pkgAcquire *Owner, std::string URI, std::string Hash, unsigned long long Size, std::string Desc, std::string ShortDesc, const std::string &DestDir="", const std::string &DestFilename="", bool IsIndexFile=false) | |
Create a new pkgAcqFile object. | |
![]() | |
virtual void | Start (std::string Message, unsigned long long Size) |
Invoked when the worker starts to fetch this object. | |
virtual std::string | ShortDesc () |
Short item description. | |
virtual void | Finished () |
Invoked by the worker when the download is completely done. | |
pkgAcquire * | GetOwner () |
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. | |
![]() | |
void | AddWeakPointer (WeakPointable **weakptr) |
void | RemoveWeakPointer (WeakPointable **weakptr) |
~WeakPointable () |
Additional Inherited Members | |
![]() | |
enum | ItemState { StatIdle, StatFetching, StatDone, StatError, StatAuthError, StatTransientNetworkError } |
The current status of this item. More... | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
pkgAcquire * | Owner |
The acquire object with which this item is associated. |
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, |
std::string | URI, | ||
std::string | Hash, | ||
unsigned long long | Size, | ||
std::string | Desc, | ||
std::string | ShortDesc, | ||
const std::string & | DestDir = "" , |
||
const std::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::DestFile, pkgAcquire::Item::FileSize, pkgAcquire::ItemDesc::Owner, pkgAcquire::Item::PartialSize, pkgAcquire::Item::QueueURI(), pkgAcquire::Item::ShortDesc(), pkgAcquire::ItemDesc::ShortDesc, and pkgAcquire::ItemDesc::URI.
|
virtual |
Custom headers to be sent to the fetch process.
Reimplemented from pkgAcquire::Item.
|
inlinevirtual |
A "descriptive" URI-like string.
Implements pkgAcquire::Item.
References pkgAcquire::ItemDesc::URI.
|
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.
References pkgAcquire::Item::Complete, pkgAcquire::Item::DestFile, pkgAcquire::Item::ErrorText, pkgAcquire::Item::Local, pkgAcquire::Item::QueueURI(), pkgAcquire::MethodConfig::Removable, pkgAcquire::Item::Rename(), pkgAcquire::Item::StatError, and pkgAcquire::ItemDesc::URI.
|
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.
References pkgAcquire::Item::ErrorText, pkgAcquire::MethodConfig::LocalOnly, and pkgAcquire::Item::QueueURI().
|
inlinevirtual |
HashSum.
Reimplemented from pkgAcquire::Item.