Send file/filesystem queries to an XRootD cluster. More...
#include <XrdClFileSystem.hh>
Public Types | |
typedef std::vector< LocationInfo > | LocationList |
Location list. | |
Public Member Functions | |
FileSystem (const URL &url) | |
~FileSystem () | |
Destructor. | |
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) |
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) |
Private Member Functions | |
Status | Send (Message *msg, ResponseHandler *handler, const MessageSendParams ¶ms) |
void | AssignLoadBalancer (const URL &url) |
void | Lock () |
void | UnLock () |
Private Attributes | |
XrdSysMutex | pMutex |
bool | pLoadBalancerLookupDone |
URL * | pUrl |
Friends | |
class | AssignLBHandler |
class | ForkHandler |
Send file/filesystem queries to an XRootD cluster.
typedef std::vector<LocationInfo> XrdCl::FileSystem::LocationList |
Location list.
XrdCl::FileSystem::FileSystem | ( | const URL & | url | ) |
Constructor
url | URL of the entry-point server to be contacted |
XrdCl::FileSystem::~FileSystem | ( | ) |
Destructor.
void XrdCl::FileSystem::AssignLoadBalancer | ( | const URL & | url | ) | [private] |
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
path | file/directory path | |
mode | access mode, or'd Access::Mode | |
timeout | timeout value, if 0 the environment default will be used |
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
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 |
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
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 |
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
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 |
XRootDStatus XrdCl::FileSystem::DirList | ( | const std::string & | path, | |
DirListFlags::Flags | flags, | |||
DirectoryList *& | response, | |||
uint16_t | timeout = 0 | |||
) |
List entries of a directory - sync
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 |
XRootDStatus XrdCl::FileSystem::DirList | ( | const std::string & | path, | |
DirListFlags::Flags | flags, | |||
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
List entries of a directory - async
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 |
XRootDStatus XrdCl::FileSystem::Locate | ( | const std::string & | path, | |
OpenFlags::Flags | flags, | |||
LocationInfo *& | response, | |||
uint16_t | timeout = 0 | |||
) |
Locate a file - sync
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 |
XRootDStatus XrdCl::FileSystem::Locate | ( | const std::string & | path, | |
OpenFlags::Flags | flags, | |||
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Locate a file - async
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 |
void XrdCl::FileSystem::Lock | ( | ) | [inline, private] |
XRootDStatus XrdCl::FileSystem::MkDir | ( | const std::string & | path, | |
MkDirFlags::Flags | flags, | |||
Access::Mode | mode, | |||
uint16_t | timeout = 0 | |||
) |
Create a directory - sync
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 |
XRootDStatus XrdCl::FileSystem::MkDir | ( | const std::string & | path, | |
MkDirFlags::Flags | flags, | |||
Access::Mode | mode, | |||
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Create a directory - async
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 |
XRootDStatus XrdCl::FileSystem::Mv | ( | const std::string & | source, | |
const std::string & | dest, | |||
uint16_t | timeout = 0 | |||
) |
Move a directory or a file - sync
source | the file or directory to be moved | |
dest | the new name | |
timeout | timeout value, if 0 the environment default will be used |
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
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 |
XRootDStatus XrdCl::FileSystem::Ping | ( | uint16_t | timeout = 0 |
) |
Check if the server is alive - sync
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::Ping | ( | ResponseHandler * | handler, | |
uint16_t | timeout = 0 | |||
) |
Check if the server is alive - async
handler | handler to be notified when the response arrives | |
timeout | timeout value, if 0 the environment default will be used |
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
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 |
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
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 |
XRootDStatus XrdCl::FileSystem::Protocol | ( | ProtocolInfo *& | response, | |
uint16_t | timeout = 0 | |||
) |
Obtain server protocol information - sync
response | the response (to be deleted by the user) | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::Protocol | ( | ResponseHandler * | handler, | |
uint16_t | timeout = 0 | |||
) |
Obtain server protocol information - async
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 |
XRootDStatus XrdCl::FileSystem::Query | ( | QueryCode::Code | queryCode, | |
const Buffer & | arg, | |||
Buffer *& | response, | |||
uint16_t | timeout = 0 | |||
) |
Obtain server information - sync
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 |
XRootDStatus XrdCl::FileSystem::Query | ( | QueryCode::Code | queryCode, | |
const Buffer & | arg, | |||
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Obtain server information - async
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 |
XRootDStatus XrdCl::FileSystem::Rm | ( | const std::string & | path, | |
uint16_t | timeout = 0 | |||
) |
Remove a file - sync
path | path to the file to be removed | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::Rm | ( | const std::string & | path, | |
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Remove a file - async
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 |
XRootDStatus XrdCl::FileSystem::RmDir | ( | const std::string & | path, | |
uint16_t | timeout = 0 | |||
) |
Remove a directory - sync
path | path to the directory to be removed | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::RmDir | ( | const std::string & | path, | |
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Remove a directory - async
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 |
Status XrdCl::FileSystem::Send | ( | Message * | msg, | |
ResponseHandler * | handler, | |||
const MessageSendParams & | params | |||
) | [private] |
XRootDStatus XrdCl::FileSystem::SendInfo | ( | const std::string & | info, | |
Buffer *& | response, | |||
uint16_t | timeout = 0 | |||
) |
Send info to the server (up to 1024 characters) - sync
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 |
XRootDStatus XrdCl::FileSystem::SendInfo | ( | const std::string & | info, | |
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Send info to the server (up to 1024 characters)- async
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 |
XRootDStatus XrdCl::FileSystem::Stat | ( | const std::string & | path, | |
StatInfo *& | response, | |||
uint16_t | timeout = 0 | |||
) |
Obtain status information for a path - sync
path | file/directory path | |
response | the response (to be deleted by the user) | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::Stat | ( | const std::string & | path, | |
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Obtain status information for a path - async
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 |
XRootDStatus XrdCl::FileSystem::StatVFS | ( | const std::string & | path, | |
StatInfoVFS *& | response, | |||
uint16_t | timeout = 0 | |||
) |
Obtain status information for a Virtual File System - sync
path | file/directory path | |
response | the response (to be deleted by the user) | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::StatVFS | ( | const std::string & | path, | |
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Obtain status information for a Virtual File System - async
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 |
XRootDStatus XrdCl::FileSystem::Truncate | ( | const std::string & | path, | |
uint64_t | size, | |||
uint16_t | timeout = 0 | |||
) |
Truncate a file - sync
path | path to the file to be truncated | |
size | file size | |
timeout | timeout value, if 0 the environment default will be used |
XRootDStatus XrdCl::FileSystem::Truncate | ( | const std::string & | path, | |
uint64_t | size, | |||
ResponseHandler * | handler, | |||
uint16_t | timeout = 0 | |||
) |
Truncate a file - async
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 |
void XrdCl::FileSystem::UnLock | ( | ) | [inline, private] |
friend class AssignLBHandler [friend] |
friend class ForkHandler [friend] |
bool XrdCl::FileSystem::pLoadBalancerLookupDone [private] |
XrdSysMutex XrdCl::FileSystem::pMutex [private] |
URL* XrdCl::FileSystem::pUrl [private] |