A monitor object for downloads controlled by the pkgAcquire class.
More...
#include <acquire.h>
|
| void * | d |
| | dpointer placeholder (for later in case we need it) More...
|
| |
A monitor object for downloads controlled by the pkgAcquire class.
{{{
- Todo:
- Why protected members?
| pkgAcquireStatus::pkgAcquireStatus |
( |
| ) |
|
Initialize all counters to 0 and the time to the current time.
| virtual pkgAcquireStatus::~pkgAcquireStatus |
( |
| ) |
|
|
inlinevirtual |
Invoked when an item is successfully and completely fetched.
Invoked when the process of fetching an item encounters a fatal error.
Invoked when some of an item's data is fetched.
| virtual void pkgAcquireStatus::Fetched |
( |
unsigned long long |
Size, |
|
|
unsigned long long |
ResumePoint |
|
) |
| |
|
virtual |
Invoked when a local or remote file has been completely fetched.
- Parameters
-
| Size | The size of the file fetched. |
| ResumePoint | How much of the file was already fetched. |
Invoked when an item is confirmed to be up-to-date.
For instance, when an HTTP download is informed that the file on the server was not modified.
| virtual bool pkgAcquireStatus::MediaChange |
( |
std::string |
Media, |
|
|
std::string |
Drive |
|
) |
| |
|
pure virtual |
Invoked when the user should be prompted to change the inserted removable media.
This method should not return until the user has confirmed to the user interface that the media change is complete.
- Parameters
-
| Media | The name of the media type that should be changed. |
| Drive | The identifying name of the drive whose media should be changed. |
- Returns
- true if the user confirms the media change, false if it is cancelled.
- Todo:
- This is a horrible blocking monster; it should be CPSed with prejudice.
| virtual bool pkgAcquireStatus::Pulse |
( |
pkgAcquire * |
Owner | ) |
|
|
virtual |
Periodically invoked while the Acquire process is underway.
Subclasses should first call pkgAcquireStatus::Pulse(), then update their status output. The download process is blocked while Pulse() is being called.
- Returns
- false if the user asked to cancel the whole Acquire process.
- See Also
- pkgAcquire::Run
| virtual void pkgAcquireStatus::Start |
( |
| ) |
|
|
virtual |
Invoked when the Acquire process starts running.
| virtual void pkgAcquireStatus::Stop |
( |
| ) |
|
|
virtual |
Invoked when the Acquire process stops running.
| unsigned long long pkgAcquireStatus::CurrentBytes |
|
protected |
| unsigned long long pkgAcquireStatus::CurrentCPS |
|
protected |
| unsigned long pkgAcquireStatus::CurrentItems |
|
protected |
The number of items that have been successfully downloaded.
| void* pkgAcquireStatus::d |
|
private |
dpointer placeholder (for later in case we need it)
| unsigned long long pkgAcquireStatus::ElapsedTime |
|
protected |
The amount of time that has elapsed since the download started.
| unsigned long long pkgAcquireStatus::FetchedBytes |
|
protected |
The total number of bytes accounted for by items that were successfully fetched.
| unsigned long long pkgAcquireStatus::LastBytes |
|
protected |
| bool pkgAcquireStatus::MorePulses |
If true, extra Pulse() invocations will be performed.
With this option set, Pulse() will be called every time that a download item starts downloading, finishes downloading, or terminates with an error.
| struct timeval pkgAcquireStatus::StartTime |
|
protected |
The time at which the download started.
| struct timeval pkgAcquireStatus::Time |
|
protected |
The last time at which this monitor object was updated.
| unsigned long long pkgAcquireStatus::TotalBytes |
|
protected |
The total number of bytes that need to be fetched.
- Warning
- This member is inaccurate, as new items might be enqueued while the download is in progress!
| unsigned long pkgAcquireStatus::TotalItems |
|
protected |
The total number of items that need to be fetched.
- Warning
- This member is inaccurate, as new items might be enqueued while the download is in progress!
| bool pkgAcquireStatus::Update |
If true, the download scheduler should call Pulse() at the next available opportunity.
The documentation for this class was generated from the following file:
1.8.3.1