apt: pkgAcqIndex Class Reference

apt 2.7.5 commandline package manager

Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
pkgAcqIndex Class Reference
Acquire system {{{

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:

## Public Member Functions
virtual void | Failed (std::string const &Message, pkgAcquire::MethodConfig const *const Cnf) APT_OVERRIDE
virtual void | Done (std::string const &Message, HashStringList const &Hashes, pkgAcquire::MethodConfig const *const Cnf) APT_OVERRIDE
virtual std::string | Custom600Headers () const APT_OVERRIDE
virtual std::string | DescURI () const APT_OVERRIDE
virtual std::string | GetMetaKey () const APT_OVERRIDE
| pkgAcqIndex (pkgAcquire *const Owner, pkgAcqMetaClearSig *const TransactionManager, IndexTarget const &Target, bool const Derived=false) APT_NONNULL(2
Public Member Functions inherited from pkgAcqBaseIndex
| pkgAcqBaseIndex (pkgAcquire *const Owner, pkgAcqMetaClearSig *const TransactionManager, IndexTarget const &Target) APT_NONNULL(2
Public Member Functions inherited from pkgAcqTransactionItem
virtual HashStringList | GetExpectedHashes () const APT_OVERRIDE
virtual bool | HashesRequired () const APT_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)
virtual std::string | GetFinalFilename () const APT_OVERRIDE
| Get the full pathname of the final file for the current URI.
virtual bool | TransactionState (TransactionStates const state) APT_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) APT_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

## ◆ DescURI()

virtual std::string DescURI | ( |  | ) | const
| inlinevirtual

Reimplemented from pkgAcqTransactionItem.

## ◆ Failed()

void Failed | ( | std::string const & | Message,
|  | pkgAcquire::MethodConfig const *const | Cnf
| ) |  |
| virtual

Reimplemented from pkgAcqBaseIndex.

## ◆ GetFinalFilename()

std::string GetFinalFilename | ( |  | ) | const
| protectedvirtual

Get the full pathname of the final file for the current URI.

Reimplemented from pkgAcqBaseIndex.

Reimplemented in pkgAcqDiffIndex.

References IndexTarget::URI.

Referenced by StageDecompressDone().

## ◆ GetMetaKey()

std::string GetMetaKey | ( |  | ) | const
| virtual

Reimplemented from pkgAcqTransactionItem.

## ◆ TransactionState()

bool TransactionState | ( | TransactionStates const | state | ) |
| protectedvirtual

Reimplemented from pkgAcqTransactionItem.

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

- apt-pkg/acquire-item.h
- apt-pkg/acquire-item.cc