Send file/filesystem queries to an XRootD cluster. More...

#include <XrdClFileSystem.hh>

Collaboration diagram for XrdCl::FileSystem:

Public Types
typedef std::vector< LocationInfo >	LocationList
	Location list. More...

Public Member Functions
	FileSystem (const URL &url)

	~FileSystem ()
	Destructor. More...

XRootDStatus	Locate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Locate (const std::string &path, OpenFlags::Flags flags, LocationInfo *&response, uint16_t timeout=0)

XRootDStatus	DeepLocate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	DeepLocate (const std::string &path, OpenFlags::Flags flags, LocationInfo *&response, uint16_t timeout=0)

XRootDStatus	Mv (const std::string &source, const std::string &dest, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Mv (const std::string &source, const std::string &dest, uint16_t timeout=0)

XRootDStatus	Query (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Query (QueryCode::Code queryCode, const Buffer &arg, Buffer *&response, uint16_t timeout=0)

XRootDStatus	Truncate (const std::string &path, uint64_t size, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Truncate (const std::string &path, uint64_t size, uint16_t timeout=0)

XRootDStatus	Rm (const std::string &path, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Rm (const std::string &path, uint16_t timeout=0)

XRootDStatus	MkDir (const std::string &path, MkDirFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	MkDir (const std::string &path, MkDirFlags::Flags flags, Access::Mode mode, uint16_t timeout=0)

XRootDStatus	RmDir (const std::string &path, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	RmDir (const std::string &path, uint16_t timeout=0)

XRootDStatus	ChMod (const std::string &path, Access::Mode mode, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	ChMod (const std::string &path, Access::Mode mode, uint16_t timeout=0)

XRootDStatus	Ping (ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Ping (uint16_t timeout=0)

XRootDStatus	Stat (const std::string &path, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Stat (const std::string &path, StatInfo *&response, uint16_t timeout=0)

XRootDStatus	StatVFS (const std::string &path, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	StatVFS (const std::string &path, StatInfoVFS *&response, uint16_t timeout=0)

XRootDStatus	Protocol (ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Protocol (ProtocolInfo *&response, uint16_t timeout=0)

XRootDStatus	DirList (const std::string &path, DirListFlags::Flags flags, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	DirList (const std::string &path, DirListFlags::Flags flags, DirectoryList *&response, uint16_t timeout=0)

XRootDStatus	SendInfo (const std::string &info, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	SendInfo (const std::string &info, Buffer *&response, uint16_t timeout=0)
	Send info to the server - sync. More...

XRootDStatus	Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, ResponseHandler *handler, uint16_t timeout=0)

XRootDStatus	Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, Buffer *&response, uint16_t timeout=0)
	Prepare one or more files for access - sync. More...

Private Member Functions
Status	Send (Message msg, ResponseHandler handler, const MessageSendParams &params)

void	AssignLoadBalancer (const URL &url)

void	Lock ()

void	UnLock ()

Private Attributes
XrdSysMutex	pMutex

bool	pLoadBalancerLookupDone

URL *	pUrl

Friends
class	AssignLBHandler

class	ForkHandler

Detailed Description

Send file/filesystem queries to an XRootD cluster.

Member Typedef Documentation

typedef std::vector<LocationInfo> XrdCl::FileSystem::LocationList

Location list.

Constructor & Destructor Documentation

XrdCl::FileSystem::FileSystem ( const URL & url )

Constructor

Parameters

url	URL of the entry-point server to be contacted

References XrdCl::DefaultEnv::GetForkHandler(), XrdCl::URL::GetURL(), pUrl, and XrdCl::ForkHandler::RegisterFileSystemObject().

Referenced by DirList().

XrdCl::FileSystem::~FileSystem ( )

Destructor.

References XrdCl::DefaultEnv::GetForkHandler(), pUrl, and XrdCl::ForkHandler::UnRegisterFileSystemObject().

Member Function Documentation

void XrdCl::FileSystem::AssignLoadBalancer ( const URL & url )

private

References XrdCl::Log::Dump(), XrdCl::FileSystemMsg, XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), pLoadBalancerLookupDone, pMutex, and pUrl.

XRootDStatus XrdCl::FileSystem::ChMod	(	const std::string &	path,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Change access mode on a directory or a file - async

Parameters

path	file/directory path
mode	access mode, or'd Access::Mode
handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientChmodRequest::dlen, kXR_chmod, ClientChmodRequest::mode, XrdCl::MessageUtils::ProcessSendParams(), ClientChmodRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by ChMod(), FileSystemTest::ChmodTest(), and DoChMod().

XRootDStatus XrdCl::FileSystem::ChMod	(	const std::string &	path,
		Access::Mode	mode,
		uint16_t	timeout = `0`
	)

Change access mode on a directory or a file - sync

Parameters

path	file/directory path
mode	access mode, or'd Access::Mode
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References ChMod(), XrdCl::Status::IsOK(), and XrdCl::MessageUtils::WaitForStatus().

XRootDStatus XrdCl::FileSystem::DeepLocate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Locate a file, recursively locate all disk servers - async

Parameters

path	path to the file to be located
flags	some of the OpenFlags::Flags
handler	handler to be notified when the response arrives, the response parameter will hold a Buffer object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References Locate().

Referenced by DeepLocate(), DirList(), DoLocate(), and FileCopyTest::UploadTestFunc().

XRootDStatus XrdCl::FileSystem::DeepLocate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		LocationInfo *&	response,
		uint16_t	timeout = `0`
	)

Locate a file, recursively locate all disk servers - sync

Parameters

path	path to the file to be located
flags	some of the OpenFlags::Flags
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References DeepLocate(), XrdCl::Status::IsOK(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::DirList	(	const std::string &	path,
		DirListFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

List entries of a directory - async

Parameters

path	directory path
flags	currently unused
handler	handler to be notified when the response arrives, the response parameter will hold a DirectoryList object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientStatRequest::dlen, kXR_dirlist, XrdCl::MessageUtils::ProcessSendParams(), ClientStatRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DirList(), FileSystemTest::DirListTest(), and DoLS().

XRootDStatus XrdCl::FileSystem::DirList	(	const std::string &	path,
		DirListFlags::Flags	flags,
		DirectoryList *&	response,
		uint16_t	timeout = `0`
	)

List entries of a directory - sync

Parameters

path	directory path
flags	DirListFlags
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::DirectoryList::Add(), XrdCl::LocationInfo::At(), XrdCl::DirectoryList::At(), XrdCl::DirectoryList::Begin(), DeepLocate(), DirList(), XrdCl::DirectoryList::End(), XrdCl::errNotFound, FileSystem(), XrdCl::LocationInfo::Location::GetAddress(), XrdCl::DirectoryList::ListEntry::GetName(), XrdCl::DirectoryList::GetParentName(), XrdCl::LocationInfo::GetSize(), XrdCl::DirectoryList::GetSize(), XrdCl::Status::IsOK(), XrdCl::DirListFlags::Locate, Locate(), XrdCl::OpenFlags::None, XrdCl::DirListFlags::Stat, Stat(), XrdCl::stError, XrdCl::stOK, XrdCl::suPartial, and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Locate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Locate a file - async

Parameters

path	path to the file to be located
flags	some of the OpenFlags::Flags
handler	handler to be notified when the response arrives, the response parameter will hold a Buffer object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientLocateRequest::dlen, kXR_locate, ClientLocateRequest::options, XrdCl::MessageUtils::ProcessSendParams(), ClientLocateRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DeepLocate(), DirList(), DoLocate(), and Locate().

XRootDStatus XrdCl::FileSystem::Locate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		LocationInfo *&	response,
		uint16_t	timeout = `0`
	)

Locate a file - sync

Parameters

path	path to the file to be located
flags	some of the OpenFlags::Flags
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Locate(), and XrdCl::MessageUtils::WaitForResponse().

void XrdCl::FileSystem::Lock ( )

inlineprivate

XRootDStatus XrdCl::FileSystem::MkDir	(	const std::string &	path,
		MkDirFlags::Flags	flags,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Create a directory - async

Parameters

path	path to the directory
flags	or'd MkDirFlags
mode	access mode, or'd Access::Mode
handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientMkdirRequest::dlen, kXR_mkdir, ClientMkdirRequest::mode, ClientMkdirRequest::options, XrdCl::MessageUtils::ProcessSendParams(), ClientMkdirRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by FileSystemTest::ChmodTest(), DoMkDir(), MkDir(), and FileSystemTest::MkdirRmdirTest().

XRootDStatus XrdCl::FileSystem::MkDir	(	const std::string &	path,
		MkDirFlags::Flags	flags,
		Access::Mode	mode,
		uint16_t	timeout = `0`
	)

Create a directory - sync

Parameters

path	path to the directory
flags	or'd MkDirFlags
mode	access mode, or'd Access::Mode
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), MkDir(), and XrdCl::MessageUtils::WaitForStatus().

XRootDStatus XrdCl::FileSystem::Mv	(	const std::string &	source,
		const std::string &	dest,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Move a directory or a file - async

Parameters

source	the file or directory to be moved
dest	the new name
handler	handler to be notified when the response arrives,
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientMvRequest::dlen, XrdCl::Buffer::GetBuffer(), kXR_mv, XrdCl::MessageUtils::ProcessSendParams(), ClientMvRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DoMv(), Mv(), and FileSystemTest::MvTest().

XRootDStatus XrdCl::FileSystem::Mv	(	const std::string &	source,
		const std::string &	dest,
		uint16_t	timeout = `0`
	)

Move a directory or a file - sync

Parameters

source	the file or directory to be moved
dest	the new name
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Mv(), and XrdCl::MessageUtils::WaitForStatus().

XRootDStatus XrdCl::FileSystem::Ping	(	ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Check if the server is alive - async

Parameters

handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::MessageUtils::CreateRequest(), kXR_ping, XrdCl::MessageUtils::ProcessSendParams(), ClientPingRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by Ping().

XRootDStatus XrdCl::FileSystem::Ping ( uint16_t timeout = 0 )

Check if the server is alive - sync

Parameters

timeout timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Ping(), and XrdCl::MessageUtils::WaitForStatus().

XRootDStatus XrdCl::FileSystem::Prepare	(	const std::vector< std::string > &	fileList,
		PrepareFlags::Flags	flags,
		uint8_t	priority,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Prepare one or more files for access - async

Parameters

fileList	list of files to be prepared
flags	PrepareFlags::Flags
priority	priority of the request 0 (lowest) - 3 (highest)
handler	handler to be notified when the response arrives, the response parameter will hold a Buffer object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientPrepareRequest::dlen, kXR_prepare, ClientPrepareRequest::options, XrdCl::MessageUtils::ProcessSendParams(), ClientPrepareRequest::prty, ClientPrepareRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by Prepare().

XRootDStatus XrdCl::FileSystem::Prepare	(	const std::vector< std::string > &	fileList,
		PrepareFlags::Flags	flags,
		uint8_t	priority,
		Buffer *&	response,
		uint16_t	timeout = `0`
	)

Prepare one or more files for access - sync.

Prepare one or more files for access - sync

Parameters

fileList	list of files to be prepared
flags	PrepareFlags::Flags
priority	priority of the request 0 (lowest) - 3 (highest)
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Prepare(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Protocol	(	ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Obtain server protocol information - async

Parameters

handler	handler to be notified when the response arrives, the response parameter will hold a ProtocolInfo object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References ClientProtocolRequest::clientpv, XrdCl::MessageUtils::CreateRequest(), kXR_protocol, kXR_PROTOCOLVERSION, XrdCl::MessageUtils::ProcessSendParams(), ClientProtocolRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by Protocol().

XRootDStatus XrdCl::FileSystem::Protocol	(	ProtocolInfo *&	response,
		uint16_t	timeout = `0`
	)

Obtain server protocol information - sync

Parameters

response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Protocol(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Query	(	QueryCode::Code	queryCode,
		const Buffer &	arg,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Obtain server information - async

Parameters

queryCode	the query code as specified in the QueryCode struct
arg	query argument
handler	handler to be notified when the response arrives, the response parameter will hold a Buffer object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientQueryRequest::dlen, XrdCl::Buffer::GetBuffer(), XrdCl::Buffer::GetSize(), ClientQueryRequest::infotype, kXR_query, XrdCl::MessageUtils::ProcessSendParams(), ClientQueryRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by XrdCl::Utils::CheckTPC(), DoQuery(), XrdCl::Utils::GetRemoteCheckSum(), and Query().

XRootDStatus XrdCl::FileSystem::Query	(	QueryCode::Code	queryCode,
		const Buffer &	arg,
		Buffer *&	response,
		uint16_t	timeout = `0`
	)

Obtain server information - sync

Parameters

queryCode	the query code as specified in the QueryCode struct
arg	query argument
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Query(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Rm	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Remove a file - async

Parameters

path	path to the file to be removed
handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientRmRequest::dlen, kXR_rm, XrdCl::MessageUtils::ProcessSendParams(), ClientRmRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DoRm(), Rm(), FileSystemTest::TruncateRmTest(), and FileCopyTest::UploadTestFunc().

XRootDStatus XrdCl::FileSystem::Rm	(	const std::string &	path,
		uint16_t	timeout = `0`
	)

Remove a file - sync

Parameters

path	path to the file to be removed
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Rm(), and XrdCl::MessageUtils::WaitForStatus().

XRootDStatus XrdCl::FileSystem::RmDir	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Remove a directory - async

Parameters

path	path to the directory to be removed
handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientRmdirRequest::dlen, kXR_rmdir, XrdCl::MessageUtils::ProcessSendParams(), ClientRmdirRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by FileSystemTest::ChmodTest(), DoRmDir(), FileSystemTest::MkdirRmdirTest(), and RmDir().

XRootDStatus XrdCl::FileSystem::RmDir	(	const std::string &	path,
		uint16_t	timeout = `0`
	)

Remove a directory - sync

Parameters

path	path to the directory to be removed
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), RmDir(), and XrdCl::MessageUtils::WaitForStatus().

Status XrdCl::FileSystem::Send	(	Message *	msg,
		ResponseHandler *	handler,
		const MessageSendParams &	params
	)

private

References AssignLBHandler, XrdCl::Log::Dump(), XrdCl::FileSystemMsg, XrdCl::Message::GetDescription(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), pLoadBalancerLookupDone, pMutex, pUrl, and XrdCl::MessageUtils::SendMessage().

Referenced by ChMod(), DirList(), Locate(), MkDir(), Mv(), Ping(), Prepare(), Protocol(), Query(), Rm(), RmDir(), SendInfo(), Stat(), StatVFS(), and Truncate().

XRootDStatus XrdCl::FileSystem::SendInfo	(	const std::string &	info,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Send info to the server (up to 1024 characters)- async

Parameters

info	the info string to be sent
handler	handler to be notified when the response arrives, the response parameter will hold a Buffer object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientSetRequest::dlen, kXR_set, XrdCl::MessageUtils::ProcessSendParams(), ClientSetRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by SendInfo().

XRootDStatus XrdCl::FileSystem::SendInfo	(	const std::string &	info,
		Buffer *&	response,
		uint16_t	timeout = `0`
	)

Send info to the server - sync.

Send info to the server (up to 1024 characters) - sync

Parameters

info	the info string to be sent
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), SendInfo(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Stat	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Obtain status information for a path - async

Parameters

path	file/directory path
handler	handler to be notified when the response arrives, the response parameter will hold a StatInfo object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientStatRequest::dlen, kXR_stat, ClientStatRequest::options, XrdCl::MessageUtils::ProcessSendParams(), ClientStatRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DirList(), DoCD(), DoStat(), main(), and Stat().

XRootDStatus XrdCl::FileSystem::Stat	(	const std::string &	path,
		StatInfo *&	response,
		uint16_t	timeout = `0`
	)

Obtain status information for a path - sync

Parameters

path	file/directory path
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), Stat(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::StatVFS	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Obtain status information for a Virtual File System - async

Parameters

path	file/directory path
handler	handler to be notified when the response arrives, the response parameter will hold a StatInfoVFS object if the procedure is successful
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Buffer::Append(), XrdCl::MessageUtils::CreateRequest(), ClientStatRequest::dlen, kXR_stat, kXR_vfs, ClientStatRequest::options, XrdCl::MessageUtils::ProcessSendParams(), ClientStatRequest::requestid, Send(), XrdCl::XRootDTransport::SetDescription(), and XrdCl::MessageSendParams::timeout.

Referenced by DoStatVFS(), and StatVFS().

XRootDStatus XrdCl::FileSystem::StatVFS	(	const std::string &	path,
		StatInfoVFS *&	response,
		uint16_t	timeout = `0`
	)

Obtain status information for a Virtual File System - sync

Parameters

path	file/directory path
response	the response (to be deleted by the user)
timeout	timeout value, if 0 the environment default will be used

Returns: status of the operation

References XrdCl::Status::IsOK(), StatVFS(), and XrdCl::MessageUtils::WaitForResponse().

XRootDStatus XrdCl::FileSystem::Truncate	(	const std::string &	path,
		uint64_t	size,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

Truncate a file - async

Parameters

path	path to the file to be truncated
size	file size
handler	handler to be notified when the response arrives
timeout	timeout value, if 0 the environment default will be used