Fetcher implementation. More...

Classes
struct	CacheInfo

Public Member Functions
	Impl ()
	Impl (const Impl &)=default
	Impl (Impl &&)=delete
Impl &	operator= (const Impl &)=delete
Impl &	operator= (Impl &&)=delete
	~Impl ()
void	setOptions (Fetcher::Options options)
Fetcher::Options	options () const
void	addIndex (const OnMediaLocation &resource)
void	enqueueDir (const OnMediaLocation &resource, bool recursive, const FileChecker &checker=FileChecker())
void	enqueueDigestedDir (const OnMediaLocation &resource, bool recursive, const FileChecker &checker=FileChecker())
void	enqueue (const OnMediaLocation &resource, const FileChecker &checker=FileChecker())
void	enqueueDigested (const OnMediaLocation &resource, const FileChecker &checker=FileChecker())
void	addCachePath (const Pathname &cache_dir, Fetcher::CacheOptions options)
void	reset ()
void	setMediaSetAccess (MediaSetAccess &media)
void	start (const Pathname &dest_dir, const ProgressData::ReceiverFnc &progress)
void	start (const Pathname &dest_dir, MediaSetAccess &media, const ProgressData::ReceiverFnc &progress_receiver)

Static Public Member Functions
static shared_ptr< Impl >	nullimpl ()
	Offer default Impl.

Private Member Functions
void	downloadAndReadIndexList (MediaSetAccess &media, const Pathname &dest_dir)
	download the indexes and reads them
void	downloadIndex (MediaSetAccess &media, const OnMediaLocation &resource, const Pathname &dest_dir)
	download the indexes and reads them
void	readIndex (const Pathname &index, const Pathname &basedir)
	reads a downloaded index file and updates internal attributes table
void	readChecksumsIndex (const Pathname &index, const Pathname &basedir)
	specific version of readIndex for CHECKSUMS file
void	readContentFileIndex (const Pathname &index, const Pathname &basedir)
	specific version of readIndex for content file
void	getDirectoryContent (MediaSetAccess &media, const OnMediaLocation &resource, filesystem::DirContent &content)
	reads the content of a directory but keeps a cache
ManagedFile	locateInCache (const OnMediaLocation &resource_r, const Pathname &destDir_r, const Pathname &inCachePath_r)
	Tries to locate the file represented by the job by looking at it's final destination first and at then the caches (matching checksum is mandatory).
void	validate (const Pathname &localfile_r, const std::list< FileChecker > &checkers_r)
	Validates the provided file against its checkers.
void	addDirJobs (MediaSetAccess &media, const OnMediaLocation &resource, const Pathname &dest_dir, FetcherJob::Flags flags)
	scan the directory and adds the individual jobs
void	autoaddIndexes (const filesystem::DirContent &content, MediaSetAccess &media, const OnMediaLocation &resource, const Pathname &dest_dir)
	auto discovery and reading of indexes
void	provideToDest (MediaSetAccess &media_r, const Pathname &destDir_r, const FetcherJob_Ptr &jobp_r)
	Provide the resource to dest_dir.
Impl *	clone () const
	clone for RWCOW_pointer

Private Attributes
std::list< FetcherJob_Ptr >	_resources
std::set< FetcherIndex_Ptr, SameFetcherIndex >	_indexes
std::set< CacheInfo >	_caches
std::map< std::string, CheckSum >	_checksums
std::map< std::string, filesystem::DirContent >	_dircontent
MediaSetAccess *	_mediaSetAccess = nullptr
Fetcher::Options	_options

Friends
std::ostream &	operator<< (std::ostream &str, const Fetcher::Impl &obj)
Impl *	rwcowClone (const Impl *rhs)

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &str, const Fetcher::Impl &obj)
	Stream output.

Detailed Description

Fetcher implementation.

Definition at line 175 of file Fetcher.cc.

Constructor & Destructor Documentation

◆ Impl() [1/3]

zypp::Fetcher::Impl::Impl ( )

Definition at line 314 of file Fetcher.cc.

◆ Impl() [2/3]

zypp::Fetcher::Impl::Impl ( const Impl & )

default

◆ Impl() [3/3]

zypp::Fetcher::Impl::Impl ( Impl && )

delete

◆ ~Impl()

zypp::Fetcher::Impl::~Impl ( )

inline

Definition at line 187 of file Fetcher.cc.

Member Function Documentation

◆ operator=() [1/2]

Impl & zypp::Fetcher::Impl::operator= ( const Impl & )

delete

◆ operator=() [2/2]

Impl & zypp::Fetcher::Impl::operator= ( Impl && )

delete

◆ setOptions()

void zypp::Fetcher::Impl::setOptions ( Fetcher::Options options )

Definition at line 319 of file Fetcher.cc.

◆ options()

Fetcher::Options zypp::Fetcher::Impl::options ( ) const

Definition at line 322 of file Fetcher.cc.

◆ addIndex()

void zypp::Fetcher::Impl::addIndex ( const OnMediaLocation & resource )

Definition at line 369 of file Fetcher.cc.

◆ enqueueDir()

void zypp::Fetcher::Impl::enqueueDir	(	const OnMediaLocation &	resource,
		bool	recursive,
		const FileChecker &	checker = FileChecker() )

Definition at line 325 of file Fetcher.cc.

◆ enqueueDigestedDir()

void zypp::Fetcher::Impl::enqueueDigestedDir	(	const OnMediaLocation &	resource,
		bool	recursive,
		const FileChecker &	checker = FileChecker() )

Definition at line 340 of file Fetcher.cc.

◆ enqueue()

void zypp::Fetcher::Impl::enqueue	(	const OnMediaLocation &	resource,
		const FileChecker &	checker = FileChecker() )

Definition at line 357 of file Fetcher.cc.

◆ enqueueDigested()

void zypp::Fetcher::Impl::enqueueDigested	(	const OnMediaLocation &	resource,
		const FileChecker &	checker = FileChecker() )

Definition at line 303 of file Fetcher.cc.

◆ addCachePath()

void zypp::Fetcher::Impl::addCachePath	(	const Pathname &	cache_dir,
		Fetcher::CacheOptions	options )

Definition at line 389 of file Fetcher.cc.

◆ reset()

void zypp::Fetcher::Impl::reset ( )

Definition at line 376 of file Fetcher.cc.

◆ setMediaSetAccess()

void zypp::Fetcher::Impl::setMediaSetAccess ( MediaSetAccess & media )

Definition at line 384 of file Fetcher.cc.

◆ start() [1/2]

void zypp::Fetcher::Impl::start	(	const Pathname &	dest_dir,
		const ProgressData::ReceiverFnc &	progress )

Definition at line 794 of file Fetcher.cc.

◆ start() [2/2]

void zypp::Fetcher::Impl::start	(	const Pathname &	dest_dir,
		MediaSetAccess &	media,
		const ProgressData::ReceiverFnc &	progress_receiver )

Definition at line 804 of file Fetcher.cc.

◆ nullimpl()

shared_ptr< Impl > zypp::Fetcher::Impl::nullimpl ( )

inlinestatic

Offer default Impl.

Definition at line 218 of file Fetcher.cc.

◆ downloadAndReadIndexList()

void zypp::Fetcher::Impl::downloadAndReadIndexList	(	MediaSetAccess &	media,
		const Pathname &	dest_dir )

private

download the indexes and reads them

Definition at line 764 of file Fetcher.cc.

◆ downloadIndex()

void zypp::Fetcher::Impl::downloadIndex	(	MediaSetAccess &	media,
		const OnMediaLocation &	resource,
		const Pathname &	dest_dir )

private

download the indexes and reads them

Definition at line 709 of file Fetcher.cc.

◆ readIndex()

void zypp::Fetcher::Impl::readIndex	(	const Pathname &	index,
		const Pathname &	basedir )

private

reads a downloaded index file and updates internal attributes table

The index lists files relative to a directory, which is normally the same as the index file is located.

Definition at line 656 of file Fetcher.cc.

◆ readChecksumsIndex()

void zypp::Fetcher::Impl::readChecksumsIndex	(	const Pathname &	index,
		const Pathname &	basedir )

private

specific version of readIndex for CHECKSUMS file

Definition at line 680 of file Fetcher.cc.

◆ readContentFileIndex()

void zypp::Fetcher::Impl::readContentFileIndex	(	const Pathname &	index,
		const Pathname &	basedir )

private

specific version of readIndex for content file

Definition at line 667 of file Fetcher.cc.

◆ getDirectoryContent()

void zypp::Fetcher::Impl::getDirectoryContent	(	MediaSetAccess &	media,
		const OnMediaLocation &	resource,
		filesystem::DirContent &	content )

private

reads the content of a directory but keeps a cache

Definition at line 496 of file Fetcher.cc.

◆ locateInCache()

ManagedFile zypp::Fetcher::Impl::locateInCache	(	const OnMediaLocation &	resource_r,
		const Pathname &	destDir_r,
		const Pathname &	inCachePath_r )

private

Tries to locate the file represented by the job by looking at it's final destination first and at then the caches (matching checksum is mandatory).

Returns the location of the file found or an empty Pathname.

Definition at line 412 of file Fetcher.cc.

◆ validate()

void zypp::Fetcher::Impl::validate	(	const Pathname &	localfile_r,
		const std::list< FileChecker > &	checkers_r )

private

Validates the provided file against its checkers.

Exceptions

Exception

Definition at line 439 of file Fetcher.cc.

◆ addDirJobs()

void zypp::Fetcher::Impl::addDirJobs	(	MediaSetAccess &	media,
		const OnMediaLocation &	resource,
		const Pathname &	dest_dir,
		FetcherJob::Flags	flags )

private

scan the directory and adds the individual jobs

Definition at line 519 of file Fetcher.cc.

◆ autoaddIndexes()

void zypp::Fetcher::Impl::autoaddIndexes	(	const filesystem::DirContent &	content,
		MediaSetAccess &	media,
		const OnMediaLocation &	resource,
		const Pathname &	dest_dir )

private

auto discovery and reading of indexes

Definition at line 468 of file Fetcher.cc.

◆ provideToDest()

void zypp::Fetcher::Impl::provideToDest	(	MediaSetAccess &	media_r,
		const Pathname &	destDir_r,
		const FetcherJob_Ptr &	jobp_r )

private

Provide the resource to dest_dir.

Definition at line 583 of file Fetcher.cc.

◆ clone()

Impl * zypp::Fetcher::Impl::clone ( ) const

inlineprivate

clone for RWCOW_pointer

Definition at line 286 of file Fetcher.cc.

◆ operator<< [1/2]

std::ostream & operator<<	(	std::ostream &	str,
		const Fetcher::Impl &	obj )

friend

◆ rwcowClone

Impl * rwcowClone ( const Impl * rhs )

friend

◆ operator<<() [2/2]

std::ostream & operator<<	(	std::ostream &	str,
		const Fetcher::Impl &	obj )

Stream output.

Definition at line 895 of file Fetcher.cc.

Member Data Documentation

◆ _resources

std::list<FetcherJob_Ptr> zypp::Fetcher::Impl::_resources

private

Definition at line 289 of file Fetcher.cc.

◆ _indexes

std::set<FetcherIndex_Ptr,SameFetcherIndex> zypp::Fetcher::Impl::_indexes

private

Definition at line 290 of file Fetcher.cc.

◆ _caches

std::set<CacheInfo> zypp::Fetcher::Impl::_caches

private

Definition at line 291 of file Fetcher.cc.

◆ _checksums

std::map<std::string, CheckSum> zypp::Fetcher::Impl::_checksums

private

Definition at line 293 of file Fetcher.cc.

◆ _dircontent

std::map<std::string, filesystem::DirContent> zypp::Fetcher::Impl::_dircontent

private

Definition at line 295 of file Fetcher.cc.

◆ _mediaSetAccess

MediaSetAccess* zypp::Fetcher::Impl::_mediaSetAccess = nullptr

private

Definition at line 297 of file Fetcher.cc.

◆ _options

Fetcher::Options zypp::Fetcher::Impl::_options

private

Definition at line 299 of file Fetcher.cc.

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

zypp/Fetcher.cc

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ Impl() [1/3]

◆ Impl() [2/3]

◆ Impl() [3/3]

◆ ~Impl()

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setOptions()

◆ options()

◆ addIndex()

◆ enqueueDir()

◆ enqueueDigestedDir()

◆ enqueue()

◆ enqueueDigested()

◆ addCachePath()

◆ reset()

◆ setMediaSetAccess()

◆ start() [1/2]

◆ start() [2/2]

◆ nullimpl()

◆ downloadAndReadIndexList()

◆ downloadIndex()

◆ readIndex()

◆ readChecksumsIndex()

◆ readContentFileIndex()

◆ getDirectoryContent()

◆ locateInCache()

◆ validate()

◆ addDirJobs()

◆ autoaddIndexes()

◆ provideToDest()

◆ clone()

Friends And Related Symbol Documentation

◆ operator<< [1/2]

◆ rwcowClone

◆ operator<<() [2/2]

Member Data Documentation

◆ _resources

◆ _indexes

◆ _caches

◆ _checksums

◆ _dircontent

◆ _mediaSetAccess

◆ _options