Class representing the status of a DTR. More...

#include <arc/data-staging/DTRStatus.h>

Public Types
enum	DTRStatusType { NEW, CHECK_CACHE, CHECKING_CACHE, CACHE_WAIT, CACHE_CHECKED, RESOLVE, RESOLVING, RESOLVED, QUERY_REPLICA, QUERYING_REPLICA, REPLICA_QUERIED, PRE_CLEAN, PRE_CLEANING, PRE_CLEANED, STAGE_PREPARE, STAGING_PREPARING, STAGING_PREPARING_WAIT, STAGED_PREPARED, TRANSFER, TRANSFERRING, TRANSFERRING_CANCEL, TRANSFERRED, RELEASE_REQUEST, RELEASING_REQUEST, REQUEST_RELEASED, REGISTER_REPLICA, REGISTERING_REPLICA, REPLICA_REGISTERED, PROCESS_CACHE, PROCESSING_CACHE, CACHE_PROCESSED, DONE, CANCELLED, CANCELLED_FINISHED, ERROR, NULL_STATE }
	Possible state values. More...

Public Member Functions
	DTRStatus (const DTRStatusType &status, std::string desc="")
	Make new DTRStatus with given status and optional description. More...

	DTRStatus ()
	Make new DTRStatus with default NEW status. More...

bool	operator== (const DTRStatusType &s) const
	Returns true if this status is the same as the given DTRStatusType. More...

bool	operator== (const DTRStatus &s) const
	Returns true if this status is the same as the given DTRStatus. More...

bool	operator!= (const DTRStatusType &s) const
	Returns true if this status is not the same as the given DTRStatusType. More...

bool	operator!= (const DTRStatus &s) const
	Returns true if this status is not the same as the given DTRStatus. More...

DTRStatus &	operator= (const DTRStatusType &s)
	Make a new DTRStatus with the same status as the given DTRStatusType. More...

std::string	str () const
	Returns a string representation of the current state. More...

void	SetDesc (const std::string &d)
	Set the detailed description of the current state. More...

std::string	GetDesc () const
	Get the detailed description of the current state. More...

DTRStatusType	GetStatus () const
	Get the DTRStatusType of the current state. More...

Static Public Attributes
static const std::vector< DTRStatus::DTRStatusType >	ToProcessStates
	Vector of states with a to be processed action, eg CHECK_CACHE. More...

static const std::vector< DTRStatus::DTRStatusType >	ProcessingStates
	Vector of states with a processing action, eg CHECKING_CACHE. More...

static const std::vector< DTRStatus::DTRStatusType >	StagedStates
	Vector of states where a DTR is staged - used to limit the number of staged files. More...

Detailed Description

Class representing the status of a DTR.

Member Enumeration Documentation

◆ DTRStatusType

enum DataStaging::DTRStatus::DTRStatusType

Possible state values.

Enumerator
NEW	Just created.
CHECK_CACHE	Check the cache for the file may be already there.
CHECKING_CACHE	Checking the cache.
CACHE_WAIT	Cache file is locked, waiting for its release.
CACHE_CHECKED	Cache check completed.
RESOLVE	Resolve a meta-protocol.
RESOLVING	Resolving replicas.
RESOLVED	Replica resolution completed.
QUERY_REPLICA	Query a replica.
QUERYING_REPLICA	Replica is being queried.
REPLICA_QUERIED	Replica was queried.
PRE_CLEAN	The destination should be deleted.
PRE_CLEANING	Deleting the destination.
PRE_CLEANED	The destination file has been deleted.
STAGE_PREPARE	Prepare or stage the source and/or destination.
STAGING_PREPARING	Making a staging or preparing request.
STAGING_PREPARING_WAIT	Wait for the status of the staging/preparing request.
STAGED_PREPARED	Staging/preparing request completed.
TRANSFER	Transfer ready and can be started.
TRANSFERRING	Transfer is going.
TRANSFERRING_CANCEL	Transfer is on-going but scheduled for cancellation.
TRANSFERRED	Transfer completed.
RELEASE_REQUEST	Transfer finished, release requests on the storage.
RELEASING_REQUEST	Releasing staging/preparing request.
REQUEST_RELEASED	Release of staging/preparing request completed.
REGISTER_REPLICA	Register a new replica of the destination.
REGISTERING_REPLICA	Registering a replica in an index service.
REPLICA_REGISTERED	Replica registration completed.
PROCESS_CACHE	Destination is cacheable, process cache.
PROCESSING_CACHE	Releasing locks and copying/linking cache files to the session dir.
CACHE_PROCESSED	Cache processing completed.
DONE	Everything completed successfully.
CANCELLED	Cancellation request fulfilled successfully.
CANCELLED_FINISHED	Cancellation request fulfilled but DTR also completed transfer successfully.
ERROR	Error occured.
NULL_STATE	"Stateless" DTR

Constructor & Destructor Documentation

◆ DTRStatus() [1/2]

DataStaging::DTRStatus::DTRStatus	(	const DTRStatusType &	status,
		std::string	desc = `""`
	)

inline

Make new DTRStatus with given status and optional description.

◆ DTRStatus() [2/2]

DataStaging::DTRStatus::DTRStatus ( )

inline

Make new DTRStatus with default NEW status.

Member Function Documentation

◆ GetDesc()

std::string DataStaging::DTRStatus::GetDesc ( ) const

inline

Get the detailed description of the current state.

◆ GetStatus()

DTRStatusType DataStaging::DTRStatus::GetStatus ( ) const

inline

Get the DTRStatusType of the current state.

◆ operator!=() [1/2]

bool DataStaging::DTRStatus::operator!= ( const DTRStatusType & s ) const

inline

Returns true if this status is not the same as the given DTRStatusType.

◆ operator!=() [2/2]

bool DataStaging::DTRStatus::operator!= ( const DTRStatus & s ) const

inline

Returns true if this status is not the same as the given DTRStatus.

◆ operator=()

DTRStatus& DataStaging::DTRStatus::operator= ( const DTRStatusType & s )

inline

Make a new DTRStatus with the same status as the given DTRStatusType.

Python interface deviation: Method is unavailable in Python interface

◆ operator==() [1/2]

bool DataStaging::DTRStatus::operator== ( const DTRStatusType & s ) const

inline

Returns true if this status is the same as the given DTRStatusType.

◆ operator==() [2/2]

bool DataStaging::DTRStatus::operator== ( const DTRStatus & s ) const

inline

Returns true if this status is the same as the given DTRStatus.

◆ SetDesc()

void DataStaging::DTRStatus::SetDesc ( const std::string & d )

inline

Set the detailed description of the current state.

◆ str()

std::string DataStaging::DTRStatus::str ( ) const

Returns a string representation of the current state.

Field Documentation

◆ ProcessingStates

const std::vector<DTRStatus::DTRStatusType> DataStaging::DTRStatus::ProcessingStates

static

Vector of states with a processing action, eg CHECKING_CACHE.

◆ StagedStates

const std::vector<DTRStatus::DTRStatusType> DataStaging::DTRStatus::StagedStates

static

Vector of states where a DTR is staged - used to limit the number of staged files.

◆ ToProcessStates

const std::vector<DTRStatus::DTRStatusType> DataStaging::DTRStatus::ToProcessStates

static

Vector of states with a to be processed action, eg CHECK_CACHE.

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

DTRStatus.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ DTRStatusType

Constructor & Destructor Documentation

◆ DTRStatus() [1/2]

◆ DTRStatus() [2/2]

Member Function Documentation

◆ GetDesc()

◆ GetStatus()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SetDesc()

◆ str()

Field Documentation

◆ ProcessingStates

◆ StagedStates

◆ ToProcessStates