Data Transfer Request. More...

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

Public Member Functions
	DTR (const std::string &source, const std::string &destination, const Arc::UserConfig &usercfg, const std::string &jobid, const uid_t &uid, DTRLogger log)
	Normal constructor. More...

	~DTR ()
	Empty destructor. More...

	operator bool () const
	Is DTR valid? More...

bool	operator! () const
	Is DTR not valid? More...

void	registerCallback (DTRCallback *cb, StagingProcesses owner)
	Register callback objects to be used during DTR processing. More...

void	reset ()
	Reset information held on this DTR, such as resolved replicas, error state etc. More...

void	set_id (const std::string &id)
	Set the ID of this DTR. Useful when passing DTR between processes. More...

std::string	get_id () const
	Get the ID of this DTR. More...

std::string	get_short_id () const
	Get an abbreviated version of the DTR ID - useful to reduce logging verbosity. More...

Arc::DataHandle &	get_source ()
	Get source handle. Return by reference since DataHandle cannot be copied. More...

Arc::DataHandle &	get_destination ()
	Get destination handle. Return by reference since DataHandle cannot be copied. More...

std::string	get_source_str () const
	Get source as a string. More...

std::string	get_destination_str () const
	Get destination as a string. More...

const Arc::UserConfig &	get_usercfg () const
	Get the UserConfig object associated with this DTR. More...

void	set_timeout (time_t value)
	Set the timeout for processing this DTR. More...

Arc::Time	get_timeout () const
	Get the timeout for processing this DTR. More...

void	set_process_time (const Arc::Period &process_time)
	Set the next processing time to current time + given time. More...

Arc::Time	get_process_time () const
	Get the next processing time for the DTR. More...

Arc::Time	get_creation_time () const
	Get the creation time. More...

Arc::Time	get_modification_time () const
	Get the modification time. More...

std::string	get_parent_job_id () const
	Get the parent job ID. More...

void	set_priority (int pri)
	Set the priority. More...

int	get_priority () const
	Get the priority. More...

void	set_rfc_proxy (bool rfc)
	Set whether credentials are type RFC proxy. More...

bool	is_rfc_proxy () const
	Get whether credentials are type RFC proxy. More...

void	set_transfer_share (const std::string &share_name)
	Set the transfer share. sub_share is automatically added to transfershare. More...

std::string	get_transfer_share () const
	Get the transfer share. sub_share is automatically added to transfershare. More...

void	set_sub_share (const std::string &share)
	Set sub-share. More...

std::string	get_sub_share () const
	Get sub-share. More...

void	set_tries_left (unsigned int tries)
	Set the number of attempts remaining. More...

unsigned int	get_tries_left () const
	Get the number of attempts remaining. More...

unsigned int	get_initial_tries () const
	Get the initial number of attempts (set by set_tries_left()) More...

void	decrease_tries_left ()
	Decrease attempt number. More...

void	set_status (DTRStatus stat)
	Set the status. Protected by lock. More...

DTRStatus	get_status ()
	Get the status. Protected by lock. More...

void	set_error_status (DTRErrorStatus::DTRErrorStatusType error_stat, DTRErrorStatus::DTRErrorLocation error_loc, const std::string &desc="")
	Set the error status. More...

void	reset_error_status ()
	Set the error status back to NONE_ERROR and clear other fields. More...

DTRErrorStatus	get_error_status ()
	Get the error status. More...

void	set_bytes_transferred (unsigned long long int bytes)
	Set bytes transferred (should be set by whatever is controlling the transfer) More...

unsigned long long int	get_bytes_transferred () const
	Get current number of bytes transferred. More...

void	set_cancel_request ()
	Set the DTR to be cancelled. More...

bool	cancel_requested () const
	Returns true if cancellation has been requested. More...

void	set_delivery_endpoint (const Arc::URL &endpoint)
	Set delivery endpoint. More...

const Arc::URL &	get_delivery_endpoint () const
	Returns delivery endpoint. More...

void	add_problematic_delivery_service (const Arc::URL &endpoint)
	Add problematic endpoint. More...

const std::vector< Arc::URL > &	get_problematic_delivery_services () const
	Get all problematic endpoints. More...

void	host_cert_for_remote_delivery (bool host)
	Set the flag for using host certificate for contacting remote delivery services. More...

bool	host_cert_for_remote_delivery () const
	Get the flag for using host certificate for contacting remote delivery services. More...

void	set_cache_file (const std::string &filename)
	Set cache filename. More...

std::string	get_cache_file () const
	Get cache filename. More...

void	set_cache_parameters (const DTRCacheParameters &param)
	Set cache parameters. More...

const DTRCacheParameters &	get_cache_parameters () const
	Get cache parameters. More...

void	set_cache_state (CacheState state)
	Set the cache state. More...

CacheState	get_cache_state () const
	Get the cache state. More...

void	set_mapped_source (const std::string &file="")
	Set the mapped file. More...

std::string	get_mapped_source () const
	Get the mapped file. More...

StagingProcesses	get_owner () const
	Find the DTR owner. More...

Arc::User	get_local_user () const
	Get the local user information. More...

void	set_replication (bool rep)
	Set replication flag. More...

bool	is_replication () const
	Get replication flag. More...

void	set_force_registration (bool force)
	Set force replication flag. More...

bool	is_force_registration () const
	Get force replication flag. More...

void	set_bulk_start (bool value)
	Set bulk start flag. More...

bool	get_bulk_start () const
	Get bulk start flag. More...

void	set_bulk_end (bool value)
	Set bulk end flag. More...

bool	get_bulk_end () const
	Get bulk start flag. More...

bool	bulk_possible ()
	Whether bulk operation is possible according to current state and src/dest. More...

const DTRLogger &	get_logger () const
	Get Logger object, so that processes can log to this DTR's log. More...

void	connect_logger ()
	Connect log destinations to logger. Only needs to be done after disconnect() More...

void	disconnect_logger ()
	Disconnect log destinations from logger. More...

bool	suspend ()
	Suspend the DTR which is in doing transfer in the delivery process. More...

bool	error () const
	Did an error happen? More...

bool	is_destined_for_pre_processor () const
	Returns true if this DTR is about to go into the pre-processor. More...

bool	is_destined_for_post_processor () const
	Returns true if this DTR is about to go into the post-processor. More...

bool	is_destined_for_delivery () const
	Returns true if this DTR is about to go into delivery. More...

bool	came_from_pre_processor () const
	Returns true if this DTR just came from the pre-processor. More...

bool	came_from_post_processor () const
	Returns true if this DTR just came from the post-processor. More...

bool	came_from_delivery () const
	Returns true if this DTR just came from delivery. More...

bool	came_from_generator () const
	Returns true if this DTR just came from the generator. More...

bool	is_in_final_state () const
	Returns true if this DTR is in a final state (finished, failed or cancelled) More...

Static Public Member Functions
static void	push (DTR_ptr dtr, StagingProcesses new_owner)
	Pass the DTR from one process to another. Protected by lock. More...

Static Public Attributes
static const Arc::URL	LOCAL_DELIVERY
	URL that is used to denote local Delivery should be used. More...

static Arc::LogLevel	LOG_LEVEL
	Log level for all DTR activity. More...

Detailed Description

Data Transfer Request.

DTR stands for Data Transfer Request and a DTR describes a data transfer between two endpoints, a source and a destination. There are several parameters and options relating to the transfer contained in a DTR. The normal workflow is for a Generator to create a DTR and send it to the Scheduler for processing using DTR::push(SCHEDULER). If the Generator is a subclass of DTRCallback, when the Scheduler has finished with the DTR the DTRCallback::receiveDTR() callback method is called.

DTRs should always be used through the Arc::ThreadedPointer DTR_ptr. This ensures proper memory management when passing DTRs among various threads. To enforce this policy the copy constructor and assignment operator are private.

A lock protects member variables that are likely to be accessed and modified by multiple threads.

Constructor & Destructor Documentation

DataStaging::DTR::DTR	(	const std::string &	source,
		const std::string &	destination,
		const Arc::UserConfig &	usercfg,
		const std::string &	jobid,
		const uid_t &	uid,
		DTRLogger	log
	)

Normal constructor.

Construct a new DTR.

Parameters

source	Endpoint from which to read data
destination	Endpoint to which to write data
usercfg	Provides some user configuration information
jobid	ID of the job associated with this data transfer
uid	UID to use when accessing local file system if source or destination is a local file. If this is different to the current uid then the current uid must have sufficient privileges to change uid.
log	ThreadedPointer containing log object. If NULL the root logger is used.

DataStaging::DTR::~DTR ( )

inline

Empty destructor.

Member Function Documentation

void DataStaging::DTR::add_problematic_delivery_service ( const Arc::URL & endpoint )

inline

Add problematic endpoint.

Should only be those endpoints where there is a problem with the service itself and not the transfer.

bool DataStaging::DTR::bulk_possible ( )

Whether bulk operation is possible according to current state and src/dest.

bool DataStaging::DTR::came_from_delivery ( ) const

Returns true if this DTR just came from delivery.

bool DataStaging::DTR::came_from_generator ( ) const

Returns true if this DTR just came from the generator.

bool DataStaging::DTR::came_from_post_processor ( ) const

Returns true if this DTR just came from the post-processor.

bool DataStaging::DTR::came_from_pre_processor ( ) const

Returns true if this DTR just came from the pre-processor.

bool DataStaging::DTR::cancel_requested ( ) const

inline

Returns true if cancellation has been requested.

void DataStaging::DTR::connect_logger ( )

inline

Connect log destinations to logger. Only needs to be done after disconnect()

void DataStaging::DTR::decrease_tries_left ( )

Decrease attempt number.

void DataStaging::DTR::disconnect_logger ( )

inline

Disconnect log destinations from logger.

bool DataStaging::DTR::error ( ) const

inline

Did an error happen?

bool DataStaging::DTR::get_bulk_end ( ) const

inline

Get bulk start flag.

bool DataStaging::DTR::get_bulk_start ( ) const

inline

Get bulk start flag.

unsigned long long int DataStaging::DTR::get_bytes_transferred ( ) const

inline

Get current number of bytes transferred.

std::string DataStaging::DTR::get_cache_file ( ) const

inline

Get cache filename.

const DTRCacheParameters& DataStaging::DTR::get_cache_parameters ( ) const

inline

Get cache parameters.

CacheState DataStaging::DTR::get_cache_state ( ) const

inline

Get the cache state.

Arc::Time DataStaging::DTR::get_creation_time ( ) const

inline

Get the creation time.

const Arc::URL& DataStaging::DTR::get_delivery_endpoint ( ) const

inline

Returns delivery endpoint.

Arc::DataHandle& DataStaging::DTR::get_destination ( )

inline

Get destination handle. Return by reference since DataHandle cannot be copied.

std::string DataStaging::DTR::get_destination_str ( ) const

inline

Get destination as a string.

DTRErrorStatus DataStaging::DTR::get_error_status ( )

Get the error status.

std::string DataStaging::DTR::get_id ( ) const

inline

Get the ID of this DTR.

unsigned int DataStaging::DTR::get_initial_tries ( ) const

inline

Get the initial number of attempts (set by set_tries_left())

Arc::User DataStaging::DTR::get_local_user ( ) const

inline

Get the local user information.

const DTRLogger& DataStaging::DTR::get_logger ( ) const

inline

Get Logger object, so that processes can log to this DTR's log.

std::string DataStaging::DTR::get_mapped_source ( ) const

inline

Get the mapped file.

Arc::Time DataStaging::DTR::get_modification_time ( ) const

inline

Get the modification time.

StagingProcesses DataStaging::DTR::get_owner ( ) const

inline

Find the DTR owner.

std::string DataStaging::DTR::get_parent_job_id ( ) const

inline

Get the parent job ID.

int DataStaging::DTR::get_priority ( ) const

inline

Get the priority.

const std::vector<Arc::URL>& DataStaging::DTR::get_problematic_delivery_services ( ) const

inline

Get all problematic endpoints.

Arc::Time DataStaging::DTR::get_process_time ( ) const

inline

Get the next processing time for the DTR.

std::string DataStaging::DTR::get_short_id ( ) const

Get an abbreviated version of the DTR ID - useful to reduce logging verbosity.

Arc::DataHandle& DataStaging::DTR::get_source ( )

inline

Get source handle. Return by reference since DataHandle cannot be copied.

std::string DataStaging::DTR::get_source_str ( ) const

inline

Get source as a string.

DTRStatus DataStaging::DTR::get_status ( )

Get the status. Protected by lock.

std::string DataStaging::DTR::get_sub_share ( ) const

inline

Get sub-share.

Arc::Time DataStaging::DTR::get_timeout ( ) const

inline

Get the timeout for processing this DTR.

std::string DataStaging::DTR::get_transfer_share ( ) const

inline

Get the transfer share. sub_share is automatically added to transfershare.

unsigned int DataStaging::DTR::get_tries_left ( ) const

inline

Get the number of attempts remaining.

const Arc::UserConfig& DataStaging::DTR::get_usercfg ( ) const

inline

Get the UserConfig object associated with this DTR.

void DataStaging::DTR::host_cert_for_remote_delivery ( bool host )

inline

Set the flag for using host certificate for contacting remote delivery services.

bool DataStaging::DTR::host_cert_for_remote_delivery ( ) const

inline

Get the flag for using host certificate for contacting remote delivery services.

bool DataStaging::DTR::is_destined_for_delivery ( ) const

Returns true if this DTR is about to go into delivery.

bool DataStaging::DTR::is_destined_for_post_processor ( ) const

Returns true if this DTR is about to go into the post-processor.

bool DataStaging::DTR::is_destined_for_pre_processor ( ) const

Returns true if this DTR is about to go into the pre-processor.

bool DataStaging::DTR::is_force_registration ( ) const

inline

Get force replication flag.

bool DataStaging::DTR::is_in_final_state ( ) const

Returns true if this DTR is in a final state (finished, failed or cancelled)

bool DataStaging::DTR::is_replication ( ) const

inline

Get replication flag.

bool DataStaging::DTR::is_rfc_proxy ( ) const

inline

Get whether credentials are type RFC proxy.

DataStaging::DTR::operator bool ( void ) const

inline

Is DTR valid?

bool DataStaging::DTR::operator! ( void ) const

inline

Is DTR not valid?

Python interface deviation: Method is unavailable in Python interface

Java interface deviation: Method is unavailable in Java interface

static void DataStaging::DTR::push	(	DTR_ptr	dtr,
		StagingProcesses	new_owner
	)

static

Pass the DTR from one process to another. Protected by lock.

void DataStaging::DTR::registerCallback	(	DTRCallback *	cb,
		StagingProcesses	owner
	)

Register callback objects to be used during DTR processing.

Objects deriving from DTRCallback can be registered with this method. The callback method of these objects will then be called when the DTR is passed to the specified owner. Protected by lock.

void DataStaging::DTR::reset ( )

Reset information held on this DTR, such as resolved replicas, error state etc.

Useful when a failed DTR is to be retried.

void DataStaging::DTR::reset_error_status ( )

Set the error status back to NONE_ERROR and clear other fields.

void DataStaging::DTR::set_bulk_end ( bool value )

inline

Set bulk end flag.

void DataStaging::DTR::set_bulk_start ( bool value )

inline

Set bulk start flag.

void DataStaging::DTR::set_bytes_transferred ( unsigned long long int bytes )

Set bytes transferred (should be set by whatever is controlling the transfer)

void DataStaging::DTR::set_cache_file ( const std::string & filename )

Set cache filename.

void DataStaging::DTR::set_cache_parameters ( const DTRCacheParameters & param )

inline

Set cache parameters.

void DataStaging::DTR::set_cache_state ( CacheState state )

Set the cache state.

void DataStaging::DTR::set_cancel_request ( )

Set the DTR to be cancelled.

void DataStaging::DTR::set_delivery_endpoint ( const Arc::URL & endpoint )

inline

Set delivery endpoint.

void DataStaging::DTR::set_error_status	(	DTRErrorStatus::DTRErrorStatusType	error_stat,
		DTRErrorStatus::DTRErrorLocation	error_loc,
		const std::string &	desc = `""`
	)

Set the error status.

The DTRErrorStatus last error state field is set to the current status of the DTR. Protected by lock.

void DataStaging::DTR::set_force_registration ( bool force )

inline

Set force replication flag.

void DataStaging::DTR::set_id ( const std::string & id )

Set the ID of this DTR. Useful when passing DTR between processes.

void DataStaging::DTR::set_mapped_source ( const std::string & file = "" )

inline

Set the mapped file.

void DataStaging::DTR::set_priority ( int pri )

Set the priority.

void DataStaging::DTR::set_process_time ( const Arc::Period & process_time )

Set the next processing time to current time + given time.

void DataStaging::DTR::set_replication ( bool rep )

inline

Set replication flag.

void DataStaging::DTR::set_rfc_proxy ( bool rfc )

inline

Set whether credentials are type RFC proxy.

void DataStaging::DTR::set_status ( DTRStatus stat )

Set the status. Protected by lock.

void DataStaging::DTR::set_sub_share ( const std::string & share )

inline

Set sub-share.

void DataStaging::DTR::set_timeout ( time_t value )

inline

Set the timeout for processing this DTR.

void DataStaging::DTR::set_transfer_share ( const std::string & share_name )

Set the transfer share. sub_share is automatically added to transfershare.

void DataStaging::DTR::set_tries_left ( unsigned int tries )

Set the number of attempts remaining.

bool DataStaging::DTR::suspend ( )

Suspend the DTR which is in doing transfer in the delivery process.

Field Documentation

const Arc::URL DataStaging::DTR::LOCAL_DELIVERY

static

URL that is used to denote local Delivery should be used.

Java interface deviation: The member is only accessible through the getLOCAL_DELIVERY and setLOCAL_DELIVERY methods in the Java interface

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation