Changed ie to eg

[apt.git] / apt-pkg / acquire-item.h

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 4a2a4e38559148fbe7efe43ae70d3b4b9679ae37..e5e7c701d5d69086bd551dcb196f317cf26d34c7 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -1,19 +1,19 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
-// $Id: acquire-item.h,v 1.11 1998/12/11 06:01:25 jgg Exp $
+// $Id: acquire-item.h,v 1.17 1999/03/27 03:02:38 jgg Exp $
 /* ######################################################################
 
    Acquire Item - Item to acquire
 
    When an item is instantiated it will add it self to the local list in
    the Owner Acquire class. Derived classes will then call QueueURI to 
-   register all the URI's they wish to fetch for at the initial moment.   
+   register all the URI's they wish to fetch at the initial moment.   
    
    Two item classes are provided to provide functionality for downloading
    of Index files and downloading of Packages.
    
    A Archive class is provided for downloading .deb files. It does Md5
-   checking and source location.
+   checking and source location as well as a retry algorithm.
    
    ##################################################################### */
                                                                        /*}}}*/
@@ -33,10 +33,13 @@ class pkgAcquire::Item
 {  
    protected:
    
+   // Some private helper methods for registering URIs
    pkgAcquire *Owner;
    inline void QueueURI(ItemDesc &Item)
                  {Owner->Enqueue(Item);};
+   inline void Dequeue() {Owner->Dequeue(this);};
    
+   // Safe rename function with timestamp preservation
    void Rename(string From,string To);
    
    public:
@@ -45,6 +48,7 @@ class pkgAcquire::Item
    enum {StatIdle, StatFetching, StatDone, StatError} Status;
    string ErrorText;
    unsigned long FileSize;
+   unsigned long PartialSize;   
    char *Mode;
    unsigned long ID;
    bool Complete;
@@ -55,14 +59,17 @@ class pkgAcquire::Item
    
    // File to write the fetch into
    string DestFile;
-   
-   virtual void Failed(string Message);
+
+   // Action members invoked by the worker
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
    virtual void Done(string Message,unsigned long Size,string Md5Hash);
    virtual void Start(string Message,unsigned long Size);
-   virtual string Describe() = 0;
-   
    virtual string Custom600Headers() {return string();};
-      
+   
+   // Inquire functions
+   virtual string MD5Sum() {return string();};
+   virtual string Describe() = 0;
+         
    Item(pkgAcquire *Owner);
    virtual ~Item();
 };
@@ -79,6 +86,7 @@ class pkgAcqIndex : public pkgAcquire::Item
    
    public:
    
+   // Specialized action members
    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();
    virtual string Describe();
@@ -96,6 +104,8 @@ class pkgAcqIndexRel : public pkgAcquire::Item
    
    public:
    
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
    virtual void Done(string Message,unsigned long Size,string Md5Hash);   
    virtual string Custom600Headers();
    virtual string Describe();
@@ -108,6 +118,7 @@ class pkgAcqArchive : public pkgAcquire::Item
 {
    protected:
    
+   // State information for the retry mechanism
    pkgCache::VerIterator Version;
    pkgAcquire::ItemDesc Desc;
    pkgSourceList *Sources;
@@ -115,13 +126,18 @@ class pkgAcqArchive : public pkgAcquire::Item
    string MD5;
    string &StoreFilename;
    pkgCache::VerFileIterator Vf;
-   
+   unsigned int Retries;
+
+   // Queue the next available file for download.
    bool QueueNext();
    
    public:
    
+   // Specialized action members
+   virtual void Failed(string Message,pkgAcquire::MethodConfig *Cnf);
    virtual void Done(string Message,unsigned long Size,string Md5Hash);
    virtual string Describe();
+   virtual string MD5Sum() {return MD5;};
    
    pkgAcqArchive(pkgAcquire *Owner,pkgSourceList *Sources,
                 pkgRecords *Recs,pkgCache::VerIterator const &Version,