apt 3.0.3
commandline package manager
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
pkgAcqIndex Class Reference

An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources). More...

#include <apt-pkg/acquire-item.h>

Inheritance diagram for pkgAcqIndex:
[legend]
Collaboration diagram for pkgAcqIndex:
[legend]

Public Member Functions

void Failed (std::string const &Message, pkgAcquire::MethodConfig const *Cnf) override
 
void Done (std::string const &Message, HashStringList const &Hashes, pkgAcquire::MethodConfig const *Cnf) override
 
std::string Custom600Headers () const override
 
std::string DescURI () const override
 
std::string GetMetaKey () const override
 
 pkgAcqIndex (pkgAcquire *const Owner, pkgAcqMetaClearSig *const TransactionManager, IndexTarget const &Target, bool const Derived=false) APT_NONNULL(2
 
- Public Member Functions inherited from pkgAcqBaseIndex
std::string GetFinalFilename () const override
 Get the full pathname of the final file for the current URI.
 
void Failed (std::string const &Message, pkgAcquire::MethodConfig const *Cnf) override
 
 pkgAcqBaseIndex (pkgAcquire *const Owner, pkgAcqMetaClearSig *const TransactionManager, IndexTarget const &Target) APT_NONNULL(2
 
- Public Member Functions inherited from pkgAcqTransactionItem
std::string DescURI () const override
 
HashStringList GetExpectedHashes () const override
 
bool HashesRequired () const override
 
virtual bool AcquireByHash () const
 
 pkgAcqTransactionItem (pkgAcquire *const Owner, pkgAcqMetaClearSig *const TransactionManager, IndexTarget const &Target) APT_NONNULL(2
 

Protected Types

enum  AllStages { STAGE_DOWNLOAD , STAGE_DECOMPRESS_AND_VERIFY }
 The stages the method goes through. More...
 

Protected Member Functions

void StageDownloadDone (std::string const &Message)
 Handle what needs to be done when the download is done.
 
void StageDecompressDone ()
 Handle what needs to be done when the decompression/copy is done.
 
void InitByHashIfNeeded ()
 Do the changes needed to fetch via AptByHash (if needed)
 
std::string GetFinalFilename () const override
 Get the full pathname of the final file for the current URI.
 
bool TransactionState (TransactionStates state) override
 
APT_HIDDEN void Init (std::string const &URI, std::string const &URIDesc, std::string const &ShortDesc)
 
APT_HIDDEN bool CommonFailed (std::string const &TargetURI, std::string const &Message, pkgAcquire::MethodConfig const *const Cnf)
 
- Protected Member Functions inherited from pkgAcqTransactionItem
HashStringList GetExpectedHashesFor (std::string const &MetaKey) const
 
bool QueueURI (pkgAcquire::ItemDesc &Item) override
 

Protected Attributes

AllStages Stage
 
std::string EraseFileName
 If set, this partially downloaded file will be removed when the download completes.
 
std::string CompressionExtensions
 The compression-related file extensions that are being added to the downloaded file one by one if first fails (e.g., "gz bz2").
 
std::string CurrentCompressionExtension
 The actual compression extension currently used.
 

Additional Inherited Members

- Public Types inherited from pkgAcqTransactionItem
enum  TransactionStates { TransactionStarted , TransactionCommit , TransactionAbort }
 
- Public Attributes inherited from pkgAcqTransactionItem
IndexTarget const Target
 
std::string PartialFile
 storge name until a transaction is finished
 
pkgAcqMetaClearSig *const TransactionManager
 TransactionManager.
 

Detailed Description

An acquire item that is responsible for fetching an index {{{ file (e.g., Packages or Sources).

See also
pkgAcqDiffIndex, pkgAcqIndexDiffs, pkgAcqIndexTrans
Todo:
Why does pkgAcqIndex have protected members?

Member Enumeration Documentation

◆ AllStages

enum AllStages
protected

The stages the method goes through.

The method first downloads the indexfile, then its decompressed (or copied) and verified

Member Function Documentation

◆ GetMetaKey()

std::string GetMetaKey ( ) const
overridevirtual

Reimplemented from pkgAcqTransactionItem.

◆ TransactionState()

bool TransactionState ( TransactionStates  state)
overrideprotectedvirtual

Reimplemented from pkgAcqTransactionItem.


The documentation for this class was generated from the following files: