// -*- mode: cpp; mode: fold -*-
// Description /*{{{*/
-// $Id: acquire.h,v 1.11 1998/11/12 04:10:55 jgg Exp $
+// $Id: acquire.h,v 1.25 1999/10/18 00:37:35 jgg Exp $
/* ######################################################################
Acquire - File Acquiration
void Enqueue(ItemDesc &Item);
void Dequeue(Item *Item);
- string QueueName(string URI);
+ string QueueName(string URI,MethodConfig const *&Config);
// FDSET managers for derived classes
- void SetFds(int &Fd,fd_set *RSet,fd_set *WSet);
- void RunFds(fd_set *RSet,fd_set *WSet);
+ virtual void SetFds(int &Fd,fd_set *RSet,fd_set *WSet);
+ virtual void RunFds(fd_set *RSet,fd_set *WSet);
// A queue calls this when it dequeues an item
void Bump();
public:
MethodConfig *GetConfig(string Access);
- bool Run();
+ enum RunResult {Continue,Failed,Cancelled};
+
+ RunResult Run();
+ void Shutdown();
+
// Simple iteration mechanism
inline Worker *WorkersBegin() {return Workers;};
Worker *WorkerStep(Worker *I);
inline Item **ItemsBegin() {return Items.begin();};
inline Item **ItemsEnd() {return Items.end();};
-
+
+ // Iterate over queued Item URIs
+ class UriIterator;
+ UriIterator UriBegin();
+ UriIterator UriEnd();
+
// Cleans out the download dir
bool Clean(string Dir);
+
+ // Returns the size of the total download set
+ unsigned long TotalNeeded();
+ unsigned long FetchNeeded();
+ unsigned long PartialPresent();
pkgAcquire(pkgAcquireStatus *Log = 0);
- ~pkgAcquire();
+ virtual ~pkgAcquire();
};
// Description of an Item+URI
class pkgAcquire::Queue
{
friend pkgAcquire;
+ friend pkgAcquire::UriIterator;
Queue *Next;
protected:
QItem *Items;
pkgAcquire::Worker *Workers;
pkgAcquire *Owner;
+ signed long PipeDepth;
+ unsigned long MaxPipeDepth;
public:
bool ItemDone(QItem *Itm);
bool Startup();
- bool Shutdown();
+ bool Shutdown(bool Final);
bool Cycle();
void Bump();
~Queue();
};
+class pkgAcquire::UriIterator
+{
+ pkgAcquire::Queue *CurQ;
+ pkgAcquire::Queue::QItem *CurItem;
+
+ public:
+
+ // Advance to the next item
+ inline void operator ++() {operator ++();};
+ void operator ++(int)
+ {
+ CurItem = CurItem->Next;
+ while (CurItem == 0 && CurQ != 0)
+ {
+ CurItem = CurQ->Items;
+ CurQ = CurQ->Next;
+ }
+ };
+
+ // Accessors
+ inline pkgAcquire::ItemDesc const *operator ->() const {return CurItem;};
+ inline bool operator !=(UriIterator const &rhs) const {return rhs.CurQ != CurQ || rhs.CurItem != CurItem;};
+ inline bool operator ==(UriIterator const &rhs) const {return rhs.CurQ == CurQ && rhs.CurItem == CurItem;};
+
+ UriIterator(pkgAcquire::Queue *Q) : CurQ(Q), CurItem(0)
+ {
+ while (CurItem == 0 && CurQ != 0)
+ {
+ CurItem = CurQ->Items;
+ CurQ = CurQ->Next;
+ }
+ }
+};
+
// Configuration information from each method
struct pkgAcquire::MethodConfig
{
string Version;
bool SingleInstance;
- bool PreScan;
bool Pipeline;
bool SendConfig;
+ bool LocalOnly;
+ bool NeedsCleanup;
MethodConfig();
};
unsigned long TotalBytes;
unsigned long FetchedBytes;
unsigned long ElapsedTime;
+ unsigned long TotalItems;
+ unsigned long CurrentItems;
public:
// Called by items when they have finished a real download
virtual void Fetched(unsigned long Size,unsigned long ResumePoint);
+ // Called to change media
+ virtual bool MediaChange(string Media,string Drive) = 0;
+
// Each of these is called by the workers when an event occures
- virtual void IMSHit(pkgAcquire::ItemDesc &Itm) {};
- virtual void Fetch(pkgAcquire::ItemDesc &Itm) {};
- virtual void Done(pkgAcquire::ItemDesc &Itm) {};
- virtual void Fail(pkgAcquire::ItemDesc &Itm) {};
- virtual void Pulse(pkgAcquire *Owner);
+ virtual void IMSHit(pkgAcquire::ItemDesc &/*Itm*/) {};
+ virtual void Fetch(pkgAcquire::ItemDesc &/*Itm*/) {};
+ virtual void Done(pkgAcquire::ItemDesc &/*Itm*/) {};
+ virtual void Fail(pkgAcquire::ItemDesc &/*Itm*/) {};
+ virtual bool Pulse(pkgAcquire *Owner); // returns false on user cancel
virtual void Start();
virtual void Stop();
-
+
pkgAcquireStatus();
virtual ~pkgAcquireStatus() {};
};