![]() |
XRootD
|
A file. More...
#include <XrdClFile.hh>
Public Types | |
enum | VirtRedirect { EnableVirtRedirect , DisableVirtRedirect } |
Public Member Functions | |
File (bool enablePlugIns=true) | |
Constructor. More... | |
File (VirtRedirect virtRedirect, bool enablePlugIns=true) | |
Constructor. More... | |
virtual | ~File () |
Destructor. More... | |
XRootDStatus | Close (ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Close (uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | DelXAttr (const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | DelXAttr (const std::vector< std::string > &attrs, std::vector< XAttrStatus > &result, uint16_t timeout=0) |
XRootDStatus | Fcntl (const Buffer &arg, Buffer *&response, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Fcntl (const Buffer &arg, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
bool | GetProperty (const std::string &name, std::string &value) const |
XRootDStatus | GetXAttr (const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | GetXAttr (const std::vector< std::string > &attrs, std::vector< XAttr > &result, uint16_t timeout=0) |
bool | IsOpen () const |
Check if the file is open. More... | |
bool | IsSecure () const |
Check if the file is using an encrypted connection. More... | |
XRootDStatus | ListXAttr (ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | ListXAttr (std::vector< XAttr > &result, uint16_t timeout=0) |
XRootDStatus | Open (const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Open (const std::string &url, OpenFlags::Flags flags, Access::Mode mode=Access::None, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | PgRead (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | PgRead (uint64_t offset, uint32_t size, void *buffer, std::vector< uint32_t > &cksums, uint32_t &bytesRead, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | PgWrite (uint64_t offset, uint32_t size, const void *buffer, std::vector< uint32_t > &cksums, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | PgWrite (uint64_t offset, uint32_t size, const void *buffer, std::vector< uint32_t > &cksums, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Read (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Read (uint64_t offset, uint32_t size, void *buffer, uint32_t &bytesRead, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | ReadV (uint64_t offset, struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | ReadV (uint64_t offset, struct iovec *iov, int iovcnt, uint32_t &bytesRead, uint16_t timeout=0) |
bool | SetProperty (const std::string &name, const std::string &value) |
XRootDStatus | SetXAttr (const std::vector< xattr_t > &attrs, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | SetXAttr (const std::vector< xattr_t > &attrs, std::vector< XAttrStatus > &result, uint16_t timeout=0) |
XRootDStatus | Stat (bool force, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Stat (bool force, StatInfo *&response, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Sync (ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Sync (uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Truncate (uint64_t size, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Truncate (uint64_t size, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | TryOtherServer (uint16_t timeout=0) |
XRootDStatus | VectorRead (const ChunkList &chunks, void *buffer, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | VectorRead (const ChunkList &chunks, void *buffer, VectorReadInfo *&vReadInfo, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | VectorWrite (const ChunkList &chunks, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | VectorWrite (const ChunkList &chunks, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Visa (Buffer *&visa, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Visa (ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
Get access token to a file - async. More... | |
XRootDStatus | Write (uint64_t offset, Buffer &&buffer, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | Write (uint64_t offset, Buffer &&buffer, uint16_t timeout=0) |
XRootDStatus | Write (uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Write (uint64_t offset, uint32_t size, const void *buffer, uint16_t timeout=0) XRD_WARN_UNUSED_RESULT |
XRootDStatus | Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, uint16_t timeout=0) |
XRootDStatus | WriteV (uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_t timeout=0) |
XRootDStatus | WriteV (uint64_t offset, const struct iovec *iov, int iovcnt, uint16_t timeout=0) |
Friends | |
template<bool HasHndl> | |
class | CheckpointImpl |
template<bool HasHndl> | |
class | ChkptWrtImpl |
template<bool HasHndl> | |
class | ChkptWrtVImpl |
A file.
Definition at line 45 of file XrdClFile.hh.
XrdCl::File::File | ( | bool | enablePlugIns = true | ) |
Constructor.
Definition at line 59 of file XrdClFile.cc.
XrdCl::File::File | ( | VirtRedirect | virtRedirect, |
bool | enablePlugIns = true |
||
) |
|
virtual |
Destructor.
Definition at line 79 of file XrdClFile.cc.
References Close(), XrdCl::DefaultEnv::GetLog(), XrdCl::DefaultEnv::GetPostMaster(), and IsOpen().
XRootDStatus XrdCl::File::Close | ( | ResponseHandler * | handler, |
uint16_t | timeout = 0 |
||
) |
Close the file - async
handler | handler to be notified about the status of the operation |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 151 of file XrdClFile.cc.
References XrdCl::FilePlugIn::Close(), XrdCl::FileStateHandler::Close(), and XrdCl::FileImpl::pStateHandler.
Referenced by ~File(), XrdPosixFile::~XrdPosixFile(), XrdCl::Recorder::Close(), Close(), XrdPosixFile::Close(), and DoTail().
XRootDStatus XrdCl::File::Close | ( | uint16_t | timeout = 0 | ) |
Close the file - sync
timeout | timeout value, if 0 the environment default will be used |
Definition at line 164 of file XrdClFile.cc.
References Close(), XrdCl::Status::code, XrdCl::Status::IsOK(), XrdCl::suAlreadyDone, and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::DelXAttr | ( | const std::vector< std::string > & | attrs, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Delete extended attributes - async
attrs | : list of extended attributes to set |
handler | : handler to be notified when the response arrives, the response parameter will hold a std::vector of XAttrStatus objects |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 731 of file XrdClFile.cc.
References XrdCl::FileStateHandler::DelXAttr(), XrdCl::errNotSupported, XrdCl::FileImpl::pStateHandler, and XrdCl::stError.
Referenced by DelXAttr().
XRootDStatus XrdCl::File::DelXAttr | ( | const std::vector< std::string > & | attrs, |
std::vector< XAttrStatus > & | result, | ||
uint16_t | timeout = 0 |
||
) |
Delete extended attributes - sync
attrs | : list of extended attributes to set |
result | : result of the operation |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 744 of file XrdClFile.cc.
References DelXAttr(), XrdCl::Status::IsOK(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Fcntl | ( | const Buffer & | arg, |
Buffer *& | response, | ||
uint16_t | timeout = 0 |
||
) |
Performs a custom operation on an open file, server implementation dependent - sync
arg | query argument |
response | the response (to be deleted by the user) |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 624 of file XrdClFile.cc.
References Fcntl(), XrdCl::Status::IsOK(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Fcntl | ( | const Buffer & | arg, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Performs a custom operation on an open file, server implementation dependent - async
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 |
Definition at line 610 of file XrdClFile.cc.
References XrdCl::FilePlugIn::Fcntl(), XrdCl::FileStateHandler::Fcntl(), and XrdCl::FileImpl::pStateHandler.
Referenced by Fcntl(), and XrdCl::Recorder::Fcntl().
bool XrdCl::File::GetProperty | ( | const std::string & | name, |
std::string & | value | ||
) | const |
Get file property
Read-only properties: DataServer [string] - the data server the file is accessed at LastURL [string] - final file URL with all the cgi information
Definition at line 878 of file XrdClFile.cc.
References XrdCl::FilePlugIn::GetProperty(), and XrdCl::FileImpl::pStateHandler.
Referenced by XrdPosixXrootd::endPoint(), XrdCl::Recorder::GetProperty(), XrdCl::ZipArchive::List(), and XrdPosixFile::Location().
XRootDStatus XrdCl::File::GetXAttr | ( | const std::vector< std::string > & | attrs, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Get extended attributes - async
attrs | : list of extended attributes to get |
handler | : handler to be notified when the response arrives, the response parameter will hold a std::vector of XAttr objects |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 698 of file XrdClFile.cc.
References XrdCl::errNotSupported, XrdCl::FileStateHandler::GetXAttr(), XrdCl::FileImpl::pStateHandler, and XrdCl::stError.
Referenced by GetXAttr().
XRootDStatus XrdCl::File::GetXAttr | ( | const std::vector< std::string > & | attrs, |
std::vector< XAttr > & | result, | ||
uint16_t | timeout = 0 |
||
) |
Get extended attributes - sync
attrs | : list of extended attributes to get |
result | : result of the operation |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 711 of file XrdClFile.cc.
References GetXAttr(), XrdCl::Status::IsOK(), and XrdCl::MessageUtils::WaitForResponse().
bool XrdCl::File::IsOpen | ( | ) | const |
Check if the file is open.
Definition at line 846 of file XrdClFile.cc.
References XrdCl::FilePlugIn::IsOpen(), and XrdCl::FileImpl::pStateHandler.
Referenced by ~File(), XrdPosixFile::~XrdPosixFile(), XrdPosixFile::Close(), XrdPosixFile::DelayedDestroy(), XrdPosixXrootd::endPoint(), XrdCl::Recorder::IsOpen(), XrdPosixFile::Location(), and XrdCl::ZipArchive::OpenFile().
bool XrdCl::File::IsSecure | ( | ) | const |
Check if the file is using an encrypted connection.
Definition at line 857 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler.
XRootDStatus XrdCl::File::ListXAttr | ( | ResponseHandler * | handler, |
uint16_t | timeout = 0 |
||
) |
List extended attributes - async
handler | : handler to be notified when the response arrives, the response parameter will hold a std::vector of XAttr objects |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 764 of file XrdClFile.cc.
References XrdCl::errNotSupported, XrdCl::FileStateHandler::ListXAttr(), XrdCl::FileImpl::pStateHandler, and XrdCl::stError.
Referenced by ListXAttr().
XRootDStatus XrdCl::File::ListXAttr | ( | std::vector< XAttr > & | result, |
uint16_t | timeout = 0 |
||
) |
List extended attributes - sync
result | : result of the operation |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 776 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), ListXAttr(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Open | ( | const std::string & | url, |
OpenFlags::Flags | flags, | ||
Access::Mode | mode, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Open the file pointed to by the given URL - async
url | url of the file to be opened |
flags | OpenFlags::Flags |
mode | Access::Mode for new files, 0 otherwise |
handler | handler to be notified about the status of the operation |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 99 of file XrdClFile.cc.
References XrdCl::PlugInFactory::CreateFile(), XrdCl::Log::Error(), XrdCl::FileMsg, XrdCl::PlugInManager::GetFactory(), XrdCl::DefaultEnv::GetLog(), XrdCl::DefaultEnv::GetPlugInManager(), XrdCl::FilePlugIn::Open(), XrdCl::FileStateHandler::Open(), and XrdCl::FileImpl::pStateHandler.
Referenced by DoTail(), XrdCl::MetalinkRedirector::Load(), XrdCl::Recorder::Open(), xrdcl_proxy::ProxyPrefixFile::Open(), and Open().
XRootDStatus XrdCl::File::Open | ( | const std::string & | url, |
OpenFlags::Flags | flags, | ||
Access::Mode | mode = Access::None , |
||
uint16_t | timeout = 0 |
||
) |
Open the file pointed to by the given URL - sync
url | url of the file to be opened |
flags | OpenFlags::Flags |
mode | Access::Mode for new files, 0 otherwise |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 135 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), Open(), and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::PgRead | ( | uint64_t | offset, |
uint32_t | size, | ||
void * | buffer, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Read number of pages at a given offset - async
offset | offset from the beginning of the file |
size | buffer size, at least 1 page big (4KB) |
buffer | a pointer to a buffer big enough to hold the data |
handler | handler to be notified when the response arrives, the response parameter will hold a PageInfo object if the procedure was successful |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 245 of file XrdClFile.cc.
References XrdCl::FileStateHandler::PgRead(), XrdCl::FilePlugIn::PgRead(), and XrdCl::FileImpl::pStateHandler.
Referenced by XrdCl::Recorder::PgRead(), PgRead(), XrdPosixFile::pgRead(), and XrdPosixFile::Read().
XRootDStatus XrdCl::File::PgRead | ( | uint64_t | offset, |
uint32_t | size, | ||
void * | buffer, | ||
std::vector< uint32_t > & | cksums, | ||
uint32_t & | bytesRead, | ||
uint16_t | timeout = 0 |
||
) |
Read a data chunk at a given offset - sync
offset | offset from the beginning of the file |
size | buffer size, at least 1 page big (4KB) |
buffer | a pointer to a buffer big enough to hold the data |
cksums | crc32c checksum for each read 4KB page |
bytesRead | number of bytes actually read |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 260 of file XrdClFile.cc.
References XrdCl::PageInfo::GetCksums(), XrdCl::PageInfo::GetLength(), XrdCl::Status::IsOK(), PgRead(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::PgWrite | ( | uint64_t | offset, |
uint32_t | size, | ||
const void * | buffer, | ||
std::vector< uint32_t > & | cksums, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write number of pages at a given offset - async
offset | offset from the beginning of the file |
size | buffer size |
buffer | a pointer to a buffer holding data pages |
cksums | the crc32c checksums for each 4KB page |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 380 of file XrdClFile.cc.
References XrdCl::FileStateHandler::PgWrite(), XrdCl::FilePlugIn::PgWrite(), and XrdCl::FileImpl::pStateHandler.
Referenced by XrdPosixFile::pgWrite(), XrdCl::Recorder::PgWrite(), and PgWrite().
XRootDStatus XrdCl::File::PgWrite | ( | uint64_t | offset, |
uint32_t | size, | ||
const void * | buffer, | ||
std::vector< uint32_t > & | cksums, | ||
uint16_t | timeout = 0 |
||
) |
Write number of pages at a given offset - sync
offset | offset from the beginning of the file |
size | buffer size |
buffer | a pointer to a buffer holding data pages |
cksums | the crc32c checksums for each 4KB page |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 396 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), PgWrite(), and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::Read | ( | uint64_t | offset, |
uint32_t | size, | ||
void * | buffer, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Read a data chunk at a given offset - async
offset | offset from the beginning of the file |
size | number of bytes to be read |
buffer | a pointer to a buffer big enough to hold the data or 0 if the buffer should be allocated by the system |
handler | handler to be notified when the response arrives, the response parameter will hold a ChunkInfo object if the procedure was successful |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 206 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::Read(), and XrdCl::FilePlugIn::Read().
Referenced by DoTail(), XrdCl::MetalinkReadHandler::HandleResponse(), XrdCl::MetalinkOpenHandler::HandleResponseWithHosts(), XrdPosixFile::Read(), XrdCl::Recorder::Read(), and Read().
XRootDStatus XrdCl::File::Read | ( | uint64_t | offset, |
uint32_t | size, | ||
void * | buffer, | ||
uint32_t & | bytesRead, | ||
uint16_t | timeout = 0 |
||
) |
Read a data chunk at a given offset - sync
offset | offset from the beginning of the file |
size | number of bytes to be read |
buffer | a pointer to a buffer big enough to hold the data |
bytesRead | number of bytes actually read |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 221 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), XrdCl::ChunkInfo::length, Read(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::ReadV | ( | uint64_t | offset, |
struct iovec * | iov, | ||
int | iovcnt, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Read data into scattered buffers in one operation - async
offset | offset from the beginning of the file |
iov | list of the buffers to be written |
iovcnt | number of buffers |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 565 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, and XrdCl::FileStateHandler::ReadV().
Referenced by ReadV().
XRootDStatus XrdCl::File::ReadV | ( | uint64_t | offset, |
struct iovec * | iov, | ||
int | iovcnt, | ||
uint32_t & | bytesRead, | ||
uint16_t | timeout = 0 |
||
) |
Read data into scattered buffers in one operation - sync
offset | offset from the beginning of the file |
iov | list of the buffers to be written |
iovcnt | number of buffers |
bytesRead | number of bytes actually read |
timeout | timeout value, if 0 then the environment default will be used |
Read data into scattered buffers in one operation - sync
offset | offset from the beginning of the file |
iov | list of the buffers to be written |
iovcnt | number of buffers |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 585 of file XrdClFile.cc.
References XrdCl::VectorReadInfo::GetSize(), XrdCl::Status::IsOK(), ReadV(), and XrdCl::MessageUtils::WaitForResponse().
bool XrdCl::File::SetProperty | ( | const std::string & | name, |
const std::string & | value | ||
) |
Set file property
File properties: ReadRecovery [true/false] - enable/disable read recovery WriteRecovery [true/false] - enable/disable write recovery FollowRedirects [true/false] - enable/disable following redirections BundledClose [true/false] - enable/disable bundled close
Definition at line 867 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, and XrdCl::FilePlugIn::SetProperty().
Referenced by XrdCl::Recorder::SetProperty().
XRootDStatus XrdCl::File::SetXAttr | ( | const std::vector< xattr_t > & | attrs, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Set extended attributes - async
attrs | : list of extended attributes to set |
handler | : handler to be notified when the response arrives, the response parameter will hold a std::vector of XAttrStatus objects |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 665 of file XrdClFile.cc.
References XrdCl::errNotSupported, XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::SetXAttr(), and XrdCl::stError.
Referenced by SetXAttr().
XRootDStatus XrdCl::File::SetXAttr | ( | const std::vector< xattr_t > & | attrs, |
std::vector< XAttrStatus > & | result, | ||
uint16_t | timeout = 0 |
||
) |
Set extended attributes - sync
attrs | : list of extended attributes to set |
result | : result of the operation |
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 678 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), SetXAttr(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Stat | ( | bool | force, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Obtain status information for this file - async
force | do not use the cached information, force re-stating |
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 |
Definition at line 177 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FilePlugIn::Stat(), and XrdCl::FileStateHandler::Stat().
Referenced by DoTail(), XrdCl::ZipArchive::List(), XrdCl::Recorder::Stat(), Stat(), and XrdPosixFile::Stat().
XRootDStatus XrdCl::File::Stat | ( | bool | force, |
StatInfo *& | response, | ||
uint16_t | timeout = 0 |
||
) |
Obtain status information for this file - sync
force | do not use the cached information, force re-stating |
response | the response (to be deleted by the user) |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 190 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), Stat(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Sync | ( | ResponseHandler * | handler, |
uint16_t | timeout = 0 |
||
) |
Commit all pending disk writes - async
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 414 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FilePlugIn::Sync(), and XrdCl::FileStateHandler::Sync().
Referenced by XrdPosixFile::Sync(), XrdCl::Recorder::Sync(), and Sync().
XRootDStatus XrdCl::File::Sync | ( | uint16_t | timeout = 0 | ) |
Commit all pending disk writes - sync
timeout | timeout value, if 0 the environment default will be used |
Definition at line 426 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), Sync(), and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::Truncate | ( | uint64_t | size, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Truncate the file to a particular size - async
size | desired size of the file |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 440 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::Truncate(), and XrdCl::FilePlugIn::Truncate().
Referenced by XrdPosixFile::Trunc(), XrdCl::Recorder::Truncate(), and Truncate().
XRootDStatus XrdCl::File::Truncate | ( | uint64_t | size, |
uint16_t | timeout = 0 |
||
) |
Truncate the file to a particular size - sync
size | desired size of the file |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 454 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), Truncate(), and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::TryOtherServer | ( | uint16_t | timeout = 0 | ) |
Try different data server
timeout | : timeout value, if 0 the environment default will be used |
Definition at line 838 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, and XrdCl::FileStateHandler::TryOtherServer().
XRootDStatus XrdCl::File::VectorRead | ( | const ChunkList & | chunks, |
void * | buffer, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Read scattered data chunks in one operation - async
chunks | list of the chunks to be read and buffers to put the data in. The default maximum chunk size is 2097136 bytes and the default maximum number of chunks per request is 1024. The server may be queried using FileSystem::Query for the actual settings. |
buffer | if zero the buffer pointers in the chunk list will be used, otherwise it needs to point to a buffer big enough to hold the requested data |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 468 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FilePlugIn::VectorRead(), and XrdCl::FileStateHandler::VectorRead().
Referenced by XrdPosixFile::ReadV(), XrdCl::Recorder::VectorRead(), and VectorRead().
XRootDStatus XrdCl::File::VectorRead | ( | const ChunkList & | chunks, |
void * | buffer, | ||
VectorReadInfo *& | vReadInfo, | ||
uint16_t | timeout = 0 |
||
) |
Read scattered data chunks in one operation - sync
chunks | list of the chunks to be read and buffers to put the data in. The default maximum chunk size is 2097136 bytes and the default maximum number of chunks per request is 1024. The server may be queried using FileSystem::Query for the actual settings. |
buffer | if zero the buffer pointers in the chunk list will be used, otherwise it needs to point to a buffer big enough to hold the requested data |
vReadInfo | buffer size and chunk information |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 482 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), VectorRead(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::VectorWrite | ( | const ChunkList & | chunks, |
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write scattered data chunks in one operation - async
chunks | list of the chunks to be written. |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 498 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FilePlugIn::VectorWrite(), and XrdCl::FileStateHandler::VectorWrite().
Referenced by XrdCl::Recorder::VectorWrite(), and VectorWrite().
XRootDStatus XrdCl::File::VectorWrite | ( | const ChunkList & | chunks, |
uint16_t | timeout = 0 |
||
) |
Write scattered data chunks in one operation - sync
chunks | list of the chunks to be written. |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 511 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), VectorWrite(), and XrdCl::MessageUtils::WaitForStatus().
XRootDStatus XrdCl::File::Visa | ( | Buffer *& | visa, |
uint16_t | timeout = 0 |
||
) |
Get access token to a file - sync
visa | the access token (to be deleted by the user) |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 651 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), Visa(), and XrdCl::MessageUtils::WaitForResponse().
XRootDStatus XrdCl::File::Visa | ( | ResponseHandler * | handler, |
uint16_t | timeout = 0 |
||
) |
Get access token to a file - async.
Get access token to a file - async
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 |
Definition at line 639 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FilePlugIn::Visa(), and XrdCl::FileStateHandler::Visa().
Referenced by Visa(), and XrdCl::Recorder::Visa().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
Buffer && | buffer, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write a data chunk at a given offset - async
offset | offset from the beginning of the file |
buffer | r-value reference to Buffer object, in this case XrdCl runtime takes ownership of the buffer |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 316 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::Write(), and XrdCl::FilePlugIn::Write().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
Buffer && | buffer, | ||
uint16_t | timeout = 0 |
||
) |
Write a data chunk at a given offset - sync
offset | offset from the beginning of the file |
buffer | r-value reference to Buffer object, in this case XrdCl runtime takes ownership of the buffer |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 330 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), XrdCl::MessageUtils::WaitForStatus(), and Write().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
uint32_t | size, | ||
const void * | buffer, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write a data chunk at a given offset - async The call interprets and returns the server response, which may be either a success or a failure, it does not contain the number of bytes that were actually written.
offset | offset from the beginning of the file |
size | number of bytes to be written |
buffer | a pointer to the buffer holding the data to be written |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 286 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::Write(), and XrdCl::FilePlugIn::Write().
Referenced by XrdPosixFile::Write(), XrdCl::Recorder::Write(), and Write().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
uint32_t | size, | ||
const void * | buffer, | ||
uint16_t | timeout = 0 |
||
) |
Write a data chunk at a given offset - sync The call interprets and returns the server response, which may be either a success or a failure, it does not contain the number of bytes that were actually written.
offset | offset from the beginning of the file |
size | number of bytes to be written |
buffer | a pointer to the buffer holding the data to be written |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 301 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), XrdCl::MessageUtils::WaitForStatus(), and Write().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
uint32_t | size, | ||
Optional< uint64_t > | fdoff, | ||
int | fd, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write a data from a given file descriptor at a given offset - async
offset | offset from the beginning of the file |
size | number of bytes to be written |
fdoff | offset of the data to be written from the file descriptor (optional, if not provided will copy data from the file descriptor at the current cursor position) |
fd | file descriptor open for reading |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 346 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::Write(), and XrdCl::FilePlugIn::Write().
XRootDStatus XrdCl::File::Write | ( | uint64_t | offset, |
uint32_t | size, | ||
Optional< uint64_t > | fdoff, | ||
int | fd, | ||
uint16_t | timeout = 0 |
||
) |
Write a data from a given file descriptor at a given offset - sync
offset | offset from the beginning of the file |
size | number of bytes to be written |
fdoff | offset of the data to be written from the file descriptor (optional, if not provided will copy data from the file descriptor at the current cursor position) |
fd | file descriptor open for reading |
timeout | timeout value, if 0 the environment default will be used |
Definition at line 362 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), XrdCl::MessageUtils::WaitForStatus(), and Write().
XRootDStatus XrdCl::File::WriteV | ( | uint64_t | offset, |
const struct iovec * | iov, | ||
int | iovcnt, | ||
ResponseHandler * | handler, | ||
uint16_t | timeout = 0 |
||
) |
Write scattered buffers in one operation - async
offset | offset from the beginning of the file |
iov | list of the buffers to be written |
iovcnt | number of buffers |
handler | handler to be notified when the response arrives |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 525 of file XrdClFile.cc.
References XrdCl::FileImpl::pStateHandler, XrdCl::FileStateHandler::WriteV(), and XrdCl::FilePlugIn::WriteV().
Referenced by WriteV().
XRootDStatus XrdCl::File::WriteV | ( | uint64_t | offset, |
const struct iovec * | iov, | ||
int | iovcnt, | ||
uint16_t | timeout = 0 |
||
) |
Write scattered buffers in one operation - sync
offset | offset from the beginning of the file |
iov | list of the buffers to |
iovcnt | number of buffers |
timeout | timeout value, if 0 then the environment default will be used |
Definition at line 540 of file XrdClFile.cc.
References XrdCl::Status::IsOK(), XrdCl::MessageUtils::WaitForStatus(), and WriteV().
|
friend |
Definition at line 790 of file XrdClFile.hh.
|
friend |
Definition at line 793 of file XrdClFile.hh.
|
friend |
Definition at line 796 of file XrdClFile.hh.