#include <catalog_traversal.h>

Inheritance diagram for swissknife::CatalogTraversalBase< ObjectFetcherT >:

Collaboration diagram for swissknife::CatalogTraversalBase< ObjectFetcherT >:

Classes
struct	CatalogJob

struct	Parameters

Public Types
enum	TraversalType { kBreadthFirst, kDepthFirst }

typedef ObjectFetcherT	ObjectFetcherTN

typedef ObjectFetcherT::CatalogTN	CatalogTN

typedef ObjectFetcherT::HistoryTN	HistoryTN

typedef CatalogTraversalData < CatalogTN >	CallbackDataTN

Public Types inherited from Observable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
typedef Callbackable < CatalogTraversalData < ObjectFetcherT::CatalogTN > >::CallbackTN *	CallbackPtr

Public Types inherited from Callbackable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
typedef CallbackBase < CatalogTraversalData < ObjectFetcherT::CatalogTN > >	CallbackTN

Public Member Functions
	CatalogTraversalBase (const Parameters &params)

virtual bool	Traverse (const TraversalType type=kBreadthFirst)=0

virtual bool	Traverse (const shash::Any &root_catalog_hash, const TraversalType type=kBreadthFirst)=0

virtual bool	TraverseList (const std::vector< shash::Any > &catalog_list, const TraversalType type=kBreadthFirst)=0

virtual bool	TraverseRevision (const shash::Any &root_catalog_hash, const TraversalType type=kBreadthFirst)=0

virtual bool	TraverseNamedSnapshots (const TraversalType type=kBreadthFirst)

void	SetCatalogInfoShim (CatalogTraversalInfoShim< CatalogTN > *shim)

Public Member Functions inherited from Observable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
virtual	~Observable ()

CallbackPtr	RegisterListener (typename BoundClosure< CatalogTraversalData< ObjectFetcherT::CatalogTN >, DelegateT, ClosureDataT >::CallbackMethod method, DelegateT *delegate, ClosureDataT data)

CallbackPtr	RegisterListener (typename BoundCallback< CatalogTraversalData< ObjectFetcherT::CatalogTN >, DelegateT >::CallbackMethod method, DelegateT *delegate)

CallbackPtr	RegisterListener (typename Callback< CatalogTraversalData< ObjectFetcherT::CatalogTN > >::CallbackFunction fn)

void	UnregisterListener (CallbackPtr callback_object)

void	UnregisterListeners ()

Protected Types
typedef std::set< shash::Any >	HashSet

Protected Types inherited from Observable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
typedef std::set< CallbackPtr >	Callbacks

Protected Member Functions
bool	PrepareCatalog (CatalogJob *job)

bool	ReopenCatalog (CatalogJob *job)

bool	CloseCatalog (const bool unlink_db, CatalogJob *job)

shash::Any	GetRepositoryRootCatalogHash ()

bool	IsBelowPruningThresholds (const CatalogJob &job, const uint64_t history_depth, const time_t timestamp_threshold)

Protected Member Functions inherited from Observable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
void	RegisterListener (CallbackPtr callback_object)

	Observable ()

void	NotifyListeners (const CatalogTraversalData< ObjectFetcherT::CatalogTN > &parameter)

Protected Attributes
ObjectFetcherT *	object_fetcher_

CatalogTraversalInfoShim < CatalogTN >	catalog_info_default_shim_

CatalogTraversalInfoShim < CatalogTN > *	catalog_info_shim_

const uint64_t	default_history_depth_

const time_t	default_timestamp_threshold_

const bool	no_close_

const bool	ignore_load_failure_

const bool	no_repeat_history_

LogFacilities	error_sink_

Additional Inherited Members
Static Public Member Functions inherited from Callbackable< CatalogTraversalData< ObjectFetcherT::CatalogTN > >
static CallbackTN *	MakeClosure (typename BoundClosure< CatalogTraversalData< ObjectFetcherT::CatalogTN >, DelegateT, ClosureDataT >::CallbackMethod method, DelegateT *delegate, const ClosureDataT &closure_data)

static CallbackTN *	MakeCallback (typename BoundCallback< CatalogTraversalData< ObjectFetcherT::CatalogTN >, DelegateT >::CallbackMethod method, DelegateT *delegate)

static CallbackTN *	MakeCallback (typename Callback< CatalogTraversalData< ObjectFetcherT::CatalogTN > >::CallbackFunction function)

Detailed Description

template<class ObjectFetcherT>
class swissknife::CatalogTraversalBase< ObjectFetcherT >

A base class for CatalogTraversal and CatalogTraversalParallel implementing common functionality. Actual traversal classes inherit from this class.

Definition at line 88 of file catalog_traversal.h.

Member Typedef Documentation

template<class ObjectFetcherT >

typedef CatalogTraversalData<CatalogTN> swissknife::CatalogTraversalBase< ObjectFetcherT >::CallbackDataTN

Definition at line 95 of file catalog_traversal.h.

template<class ObjectFetcherT >

typedef ObjectFetcherT::CatalogTN swissknife::CatalogTraversalBase< ObjectFetcherT >::CatalogTN

Definition at line 93 of file catalog_traversal.h.

template<class ObjectFetcherT >

typedef std::set<shash::Any> swissknife::CatalogTraversalBase< ObjectFetcherT >::HashSet

protected

Definition at line 268 of file catalog_traversal.h.

template<class ObjectFetcherT >

typedef ObjectFetcherT::HistoryTN swissknife::CatalogTraversalBase< ObjectFetcherT >::HistoryTN

Definition at line 94 of file catalog_traversal.h.

template<class ObjectFetcherT >

typedef ObjectFetcherT swissknife::CatalogTraversalBase< ObjectFetcherT >::ObjectFetcherTN

Definition at line 92 of file catalog_traversal.h.

Member Enumeration Documentation

template<class ObjectFetcherT >

enum swissknife::CatalogTraversalBase::TraversalType

Enumerator
kBreadthFirst
kDepthFirst

Definition at line 162 of file catalog_traversal.h.

Constructor & Destructor Documentation

template<class ObjectFetcherT >

swissknife::CatalogTraversalBase< ObjectFetcherT >::CatalogTraversalBase ( const Parameters & params )

inlineexplicit

Definition at line 167 of file catalog_traversal.h.

Here is the call graph for this function:

Member Function Documentation

template<class ObjectFetcherT >

bool swissknife::CatalogTraversalBase< ObjectFetcherT >::CloseCatalog	(	const bool	unlink_db,
		CatalogJob *	job
	)

inlineprotected

Definition at line 373 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversal< ObjectFetcherT >::PostponeYield(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::ProcessJobPost(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::ProcessJobPre(), and swissknife::CatalogTraversal< ObjectFetcherT >::Yield().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ObjectFetcherT >

shash::Any swissknife::CatalogTraversalBase< ObjectFetcherT >::GetRepositoryRootCatalogHash ( )

inlineprotected

Definition at line 388 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalParallel< ObjectFetcherT >::Traverse(), and swissknife::CatalogTraversal< ObjectFetcherT >::Traverse().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ObjectFetcherT >

bool swissknife::CatalogTraversalBase< ObjectFetcherT >::IsBelowPruningThresholds	(	const CatalogJob &	job,
		const uint64_t	history_depth,
		const time_t	timestamp_threshold
	)

inlineprotected

Checks if a root catalog is below one of the pruning thresholds. Pruning thresholds can be either the catalog's history depth or a timestamp threshold applied to the last modified timestamp of the catalog.

Parameters

ctx	traversal context for traversal-specific state
job	the job defining the current catalog

Returns: true if either history or timestamp threshold are satisfied

Definition at line 414 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalParallel< ObjectFetcherT >::PushPreviousRevision(), and swissknife::CatalogTraversal< ObjectFetcherT >::PushPreviousRevision().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ObjectFetcherT >

bool swissknife::CatalogTraversalBase< ObjectFetcherT >::PrepareCatalog ( CatalogJob * job )

inlineprotected

Definition at line 314 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversal< ObjectFetcherT >::DoTraverse(), and swissknife::CatalogTraversalParallel< ObjectFetcherT >::ProcessJobPre().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ObjectFetcherT >

bool swissknife::CatalogTraversalBase< ObjectFetcherT >::ReopenCatalog ( CatalogJob * job )

inlineprotected

Definition at line 353 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalParallel< ObjectFetcherT >::ProcessJobPost().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class ObjectFetcherT >

void swissknife::CatalogTraversalBase< ObjectFetcherT >::SetCatalogInfoShim ( CatalogTraversalInfoShim< CatalogTN > * shim )

inline

Definition at line 263 of file catalog_traversal.h.

template<class ObjectFetcherT >

virtual bool swissknife::CatalogTraversalBase< ObjectFetcherT >::Traverse ( const TraversalType type = kBreadthFirst )

pure virtual

Starts the traversal process. After calling this methods CatalogTraversal will go through all catalogs and call the registered callback methods for each found catalog. If something goes wrong in the process, the traversal will be cancelled.

Parameters

type	breadths or depth first traversal

Returns: true, when all catalogs were successfully processed. On failure the traversal is cancelled and false is returned.

Implemented in swissknife::CatalogTraversal< ObjectFetcherT >, and swissknife::CatalogTraversalParallel< ObjectFetcherT >.

template<class ObjectFetcherT >

virtual bool swissknife::CatalogTraversalBase< ObjectFetcherT >::Traverse	(	const shash::Any &	root_catalog_hash,
		const TraversalType	type = `kBreadthFirst`
	)

pure virtual

Starts the traversal process at the catalog pointed to by the given hash

Parameters

root_catalog_hash	the entry point into the catalog traversal
type	breadths or depth first traversal

Returns: true when catalogs were successfully traversed

Implemented in swissknife::CatalogTraversal< ObjectFetcherT >, and swissknife::CatalogTraversalParallel< ObjectFetcherT >.

template<class ObjectFetcherT >

virtual bool swissknife::CatalogTraversalBase< ObjectFetcherT >::TraverseList	(	const std::vector< shash::Any > &	catalog_list,
		const TraversalType	type = `kBreadthFirst`
	)

pure virtual

Traverse a list of revisions represented by root catalogs from first to last. DO NOT traverse previous revisions based on history and timestamp threshold settings.

Parameters

catalog_list	list of root catalog hashes
type	breadth- or depth- first traversal

Returns: true on success

Implemented in swissknife::CatalogTraversal< ObjectFetcherT >.

Referenced by swissknife::CatalogTraversalBase< ObjectFetcherT >::TraverseNamedSnapshots().

Here is the caller graph for this function:

template<class ObjectFetcherT >

virtual bool swissknife::CatalogTraversalBase< ObjectFetcherT >::TraverseNamedSnapshots ( const TraversalType type = kBreadthFirst )

inlinevirtual

Figures out all named tags in a repository and uses all of them as entry points into the traversal process.

Parameters

type	breadths or depth first traversal

Returns: true when catalog traversal successfully finished

Definition at line 233 of file catalog_traversal.h.

Here is the call graph for this function:

template<class ObjectFetcherT >

virtual bool swissknife::CatalogTraversalBase< ObjectFetcherT >::TraverseRevision	(	const shash::Any &	root_catalog_hash,
		const TraversalType	type = `kBreadthFirst`
	)

pure virtual

Starts the traversal process at the catalog pointed to by the given hash but doesn't traverse into predecessor catalog revisions. This overrides the TraversalParameter settings provided at construction.

Parameters

root_catalog_hash	the entry point into the catalog traversal
type	breadths or depth first traversal

Returns: true when catalogs were successfully traversed

Implemented in swissknife::CatalogTraversal< ObjectFetcherT >, and swissknife::CatalogTraversalParallel< ObjectFetcherT >.

Member Data Documentation

template<class ObjectFetcherT >

CatalogTraversalInfoShim<CatalogTN> swissknife::CatalogTraversalBase< ObjectFetcherT >::catalog_info_default_shim_

protected

Definition at line 432 of file catalog_traversal.h.

template<class ObjectFetcherT >

CatalogTraversalInfoShim<CatalogTN>* swissknife::CatalogTraversalBase< ObjectFetcherT >::catalog_info_shim_

protected

Definition at line 433 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalBase< ObjectFetcherT >::IsBelowPruningThresholds(), and swissknife::CatalogTraversalBase< ObjectFetcherT >::SetCatalogInfoShim().

template<class ObjectFetcherT >

const uint64_t swissknife::CatalogTraversalBase< ObjectFetcherT >::default_history_depth_

protected

Definition at line 434 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalParallel< ObjectFetcherT >::CatalogTraversalParallel(), swissknife::CatalogTraversal< ObjectFetcherT >::Traverse(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::TraverseList(), and swissknife::CatalogTraversalParallel< ObjectFetcherT >::TraverseRevision().

template<class ObjectFetcherT >

const time_t swissknife::CatalogTraversalBase< ObjectFetcherT >::default_timestamp_threshold_

protected

Definition at line 435 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalParallel< ObjectFetcherT >::CatalogTraversalParallel(), swissknife::CatalogTraversal< ObjectFetcherT >::Traverse(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::TraverseList(), and swissknife::CatalogTraversalParallel< ObjectFetcherT >::TraverseRevision().

template<class ObjectFetcherT >

LogFacilities swissknife::CatalogTraversalBase< ObjectFetcherT >::error_sink_

protected

Definition at line 439 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalBase< ObjectFetcherT >::CloseCatalog(), swissknife::CatalogTraversalBase< ObjectFetcherT >::PrepareCatalog(), and swissknife::CatalogTraversalBase< ObjectFetcherT >::ReopenCatalog().

template<class ObjectFetcherT >

const bool swissknife::CatalogTraversalBase< ObjectFetcherT >::ignore_load_failure_

protected

Definition at line 437 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalBase< ObjectFetcherT >::PrepareCatalog().

template<class ObjectFetcherT >

const bool swissknife::CatalogTraversalBase< ObjectFetcherT >::no_close_

protected

Definition at line 436 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversal< ObjectFetcherT >::PostponeYield(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::ProcessJobPost(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::PushNestedCatalogs(), swissknife::CatalogTraversal< ObjectFetcherT >::PushNestedCatalogs(), and swissknife::CatalogTraversal< ObjectFetcherT >::Yield().

template<class ObjectFetcherT >

const bool swissknife::CatalogTraversalBase< ObjectFetcherT >::no_repeat_history_

protected

Definition at line 438 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversal< ObjectFetcherT >::MarkAsVisited(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::PushNestedCatalogs(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::PushPreviousRevision(), swissknife::CatalogTraversal< ObjectFetcherT >::ShouldBeSkipped(), swissknife::CatalogTraversalParallel< ObjectFetcherT >::Traverse(), and swissknife::CatalogTraversalParallel< ObjectFetcherT >::TraverseList().

template<class ObjectFetcherT >

ObjectFetcherT* swissknife::CatalogTraversalBase< ObjectFetcherT >::object_fetcher_

protected

Definition at line 431 of file catalog_traversal.h.

Referenced by swissknife::CatalogTraversalBase< ObjectFetcherT >::CatalogTraversalBase(), swissknife::CatalogTraversalBase< ObjectFetcherT >::GetRepositoryRootCatalogHash(), swissknife::CatalogTraversalBase< ObjectFetcherT >::PrepareCatalog(), and swissknife::CatalogTraversalBase< ObjectFetcherT >::TraverseNamedSnapshots().

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

/home/sftnight/jenkins/workspace/CvmfsDoxygen/label/docker-x86_64/cvmfs/cvmfs/catalog_traversal.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class ObjectFetcherT> class swissknife::CatalogTraversalBase< ObjectFetcherT >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class ObjectFetcherT>
class swissknife::CatalogTraversalBase< ObjectFetcherT >