Go to the documentation of this file.
26 #ifndef __XRD_CL_FILE_OPERATIONS_HH__
27 #define __XRD_CL_FILE_OPERATIONS_HH__
44 template<
template<
bool>
class Derived,
bool HasHndl,
typename Response,
typename ... Arguments>
48 template<
template<
bool>
class, bool,
typename,
typename ...>
friend class FileOperation;
94 template<
bool HasHndl>
147 Arg<
Access::Mode>>( std::move( f ), std::move( url ), std::move( flags ),
178 template<
typename Hdlr>
181 ExResp factory( *this->file );
182 return this->StreamImpl( factory.
Create( hdlr ) );
203 const std::string &url = std::get<UrlArg>( this->args );
206 uint16_t timeout = pipelineTimeout < this->timeout ?
207 pipelineTimeout : this->timeout;
208 return this->file->Open( url, flags, mode, handler, timeout );
216 template<
bool HasHndl>
218 Arg<uint64_t>, Arg<uint32_t>, Arg<void*>>
252 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
253 uint32_t size = std::get<SizeArg>( this->
args ).Get();
254 void *buffer = std::get<BufferArg>( this->
args ).Get();
255 uint16_t
timeout = pipelineTimeout < this->timeout ?
256 pipelineTimeout : this->
timeout;
267 return ReadImpl<false>( std::move( file ), std::move( offset ), std::move( size ),
268 std::move( buffer ) ).
Timeout( timeout );
274 template<
bool HasHndl>
303 uint16_t
timeout = pipelineTimeout < this->timeout ?
304 pipelineTimeout : this->
timeout;
313 template<
bool HasHndl>
347 bool force = std::get<ForceArg>( this->
args ).Get();
348 uint16_t
timeout = pipelineTimeout < this->timeout ?
349 pipelineTimeout : this->
timeout;
366 template<
bool HasHndl>
368 Arg<uint32_t>, Arg<const void*>>
402 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
403 uint32_t size = std::get<SizeArg>( this->
args ).Get();
404 const void *buffer = std::get<BufferArg>( this->
args ).Get();
405 uint16_t
timeout = pipelineTimeout < this->timeout ?
406 pipelineTimeout : this->
timeout;
417 return WriteImpl<false>( std::move( file ), std::move( offset ), std::move( size ),
418 std::move( buffer ) ).
Timeout( timeout );
424 template<
bool HasHndl>
453 uint16_t
timeout = pipelineTimeout < this->timeout ?
454 pipelineTimeout : this->
timeout;
463 template<
bool HasHndl>
497 uint64_t size = std::get<SizeArg>( this->
args ).Get();
498 uint16_t
timeout = pipelineTimeout < this->timeout ?
499 pipelineTimeout : this->
timeout;
516 template<
bool HasHndl>
518 Resp<VectorReadInfo>, Arg<ChunkList>, Arg<void*>>
553 void *buffer = std::get<BufferArg>( this->
args ).Get();
554 uint16_t
timeout = pipelineTimeout < this->timeout ?
555 pipelineTimeout : this->
timeout;
564 template<
bool HasHndl>
585 return "VectorWrite";
599 const ChunkList &chunks = std::get<ChunksArg>( this->
args ).Get();
600 uint16_t
timeout = pipelineTimeout < this->timeout ?
601 pipelineTimeout : this->
timeout;
610 template<
bool HasHndl>
612 Arg<std::vector<iovec>>>
646 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
647 std::vector<iovec> &stdiov = std::get<IovArg>( this->
args ).Get();
648 uint16_t
timeout = pipelineTimeout < this->timeout ?
649 pipelineTimeout : this->
timeout;
651 int iovcnt = stdiov.size();
653 for(
size_t i = 0; i < stdiov.size(); ++i )
655 iov[i].iov_base = stdiov[i].iov_base;
656 iov[i].iov_len = stdiov[i].iov_len;
667 Arg<std::vector<iovec>>
iov, uint16_t timeout = 0 )
676 template<
bool HasHndl>
710 Buffer &arg = std::get<BufferArg>( this->
args ).Get();
711 uint16_t
timeout = pipelineTimeout < this->timeout ?
712 pipelineTimeout : this->
timeout;
721 template<
bool HasHndl>
750 uint16_t
timeout = pipelineTimeout < this->timeout ?
751 pipelineTimeout : this->
timeout;
760 template<
bool HasHndl>
762 Arg<std::string>, Arg<std::string>>
782 return "SetXAttrImpl";
796 std::string &name = std::get<NameArg>( this->
args ).Get();
797 std::string &value = std::get<ValueArg>( this->
args ).Get();
799 std::vector<xattr_t> attrs;
800 attrs.push_back(
xattr_t( name, value ) );
803 uint16_t
timeout = pipelineTimeout < this->timeout ?
804 pipelineTimeout : this->
timeout;
806 if( !st.
IsOK() )
delete h;
823 template<
bool HasHndl>
825 Resp<std::vector<XAttrStatus>>, Arg<std::vector<xattr_t>>>
845 return "SetXAttrBulkImpl";
860 std::vector<xattr_t> &attrs = std::get<AttrsArg>( this->
args ).Get();
861 uint16_t
timeout = pipelineTimeout < this->timeout ?
862 pipelineTimeout : this->
timeout;
879 template<
bool HasHndl>
901 return "GetXAttrImpl";
915 std::string &name = std::get<NameArg>( this->
args ).Get();
917 std::vector<std::string> attrs;
918 attrs.push_back( name );
921 uint16_t
timeout = pipelineTimeout < this->timeout ?
922 pipelineTimeout : this->
timeout;
941 template<
bool HasHndl>
943 Arg<std::vector<std::string>>>
963 return "GetXAttrBulkImpl";
978 std::vector<std::string> &attrs = std::get<NamesArg>( this->
args ).Get();
979 uint16_t
timeout = pipelineTimeout < this->timeout ?
980 pipelineTimeout : this->
timeout;
997 template<
bool HasHndl>
1018 return "DelXAttrImpl";
1032 std::string &name = std::get<NameArg>( this->
args ).Get();
1034 std::vector<std::string> attrs;
1035 attrs.push_back( name );
1038 uint16_t
timeout = pipelineTimeout < this->timeout ?
1039 pipelineTimeout : this->
timeout;
1041 if( !st.
IsOK() )
delete h;
1058 template<
bool HasHndl>
1060 Resp<std::vector<XAttrStatus>>, Arg<std::vector<std::string>>>
1080 return "DelXAttrBulkImpl";
1095 std::vector<std::string> &attrs = std::get<NamesArg>( this->
args ).Get();
1096 uint16_t
timeout = pipelineTimeout < this->timeout ?
1097 pipelineTimeout : this->
timeout;
1114 template<
bool HasHndl>
1116 Resp<std::vector<XAttr>>>
1130 return "ListXAttrImpl";
1145 uint16_t
timeout = pipelineTimeout < this->timeout ?
1146 pipelineTimeout : this->
timeout;
1161 #endif // __XRD_CL_FILE_OPERATIONS_HH__
GetXAttrImpl< false > GetXAttr(Ctx< File > file, Arg< std::string > name)
Definition: XrdClFileOperations.hh:933
Definition: XrdClOperationHandlers.hh:624
Derived< HasHndl > Timeout(uint16_t timeout)
Set operation timeout.
Definition: XrdClOperations.hh:671
Write operation (.
Definition: XrdClFileOperations.hh:369
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:858
Handle an async response.
Definition: XrdClXRootDResponses.hh:1051
@ SizeArg
Definition: XrdClFileOperations.hh:381
SetXAttr bulk operation (.
Definition: XrdClFileOperations.hh:826
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:913
@ ChunksArg
Definition: XrdClFileOperations.hh:531
@ BufferArg
Definition: XrdClFileOperations.hh:381
@ IovArg
Definition: XrdClFileOperations.hh:625
@ NameArg
Definition: XrdClFileOperations.hh:894
std::string ToString()
Definition: XrdClFileOperations.hh:694
OpenImpl< false > Open
Definition: XrdClFileOperations.hh:211
CloseImpl< false > Close
Definition: XrdClFileOperations.hh:308
Access mode.
Definition: XrdClFileSystem.hh:117
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:400
Definition: XrdClFileOperations.hh:106
ResponseHandler * Create(std::function< void(XRootDStatus &, StatInfo &)> func)
Definition: XrdClFileOperations.hh:122
std::string ToString()
Definition: XrdClFileOperations.hh:386
TruncateImpl< false > Truncate(Ctx< File > file, Arg< uint64_t > size)
Definition: XrdClFileOperations.hh:508
std::string ToString()
Definition: XrdClFileOperations.hh:1016
virtual ~FileOperation()
Destructor.
Definition: XrdClFileOperations.hh:78
GetXAttr bulk operation (.
Definition: XrdClFileOperations.hh:944
SetXAttrImpl< false > SetXAttr(Ctx< File > file, Arg< std::string > name, Arg< std::string > value)
Definition: XrdClFileOperations.hh:815
uint16_t timeout
Operation timeout.
Definition: XrdClOperations.hh:766
std::string ToString()
Definition: XrdClFileOperations.hh:481
OpenImpl< true > operator>>(Hdlr &&hdlr)
Definition: XrdClFileOperations.hh:179
Open operation (.
Definition: XrdClFileOperations.hh:97
VectorRead operation (.
Definition: XrdClFileOperations.hh:519
Utility class for storing a pointer to operation context.
Definition: XrdClCtx.hh:38
SetXAttr operation (.
Definition: XrdClFileOperations.hh:763
Definition: XrdClOperations.hh:59
OpenImpl(Ctx< File > f, Arg< std::string > url, Arg< OpenFlags::Flags > flags, Arg< Access::Mode > mode=Access::None)
Constructor (.
Definition: XrdClFileOperations.hh:144
Stat operation (.
Definition: XrdClFileOperations.hh:315
GetXAttr operation (.
Definition: XrdClFileOperations.hh:882
DelXAttrImpl< false > DelXAttr(Ctx< File > file, Arg< std::string > name)
Definition: XrdClFileOperations.hh:1050
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:495
@ BufferArg
Definition: XrdClFileOperations.hh:231
@ AttrsArg
Definition: XrdClFileOperations.hh:838
std::string ToString()
Definition: XrdClFileOperations.hh:961
Definition: XrdClArg.hh:295
std::unique_ptr< PipelineHandler > handler
Operation handler.
Definition: XrdClOperations.hh:304
WriteV operation (.
Definition: XrdClFileOperations.hh:613
Ctx< File > file
The file object itself.
Definition: XrdClFileOperations.hh:88
std::string ToString()
Definition: XrdClFileOperations.hh:899
Open flags, may be or'd when appropriate.
Definition: XrdClFileSystem.hh:71
friend class FileOperation
Definition: XrdClFileOperations.hh:48
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:550
FileOperation(Ctx< File > f, Arguments... args)
Definition: XrdClFileOperations.hh:57
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:976
@ NamesArg
Definition: XrdClFileOperations.hh:956
StatImpl< false > Stat(Ctx< File > file, Arg< bool > force, uint16_t timeout=0)
Definition: XrdClFileOperations.hh:358
std::string ToString()
Definition: XrdClFileOperations.hh:236
std::string ToString()
Definition: XrdClFileOperations.hh:734
Close operation (.
Definition: XrdClFileOperations.hh:276
Mode
Access mode.
Definition: XrdClFileSystem.hh:122
std::tuple< Args... > args
Operation arguments.
Definition: XrdClOperations.hh:761
Truncate operation (.
Definition: XrdClFileOperations.hh:465
Definition: XrdClOperations.hh:542
@ UrlArg
Definition: XrdClFileOperations.hh:170
std::string ToString()
Definition: XrdClFileOperations.hh:188
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:301
std::string ToString()
Definition: XrdClFileOperations.hh:780
std::string ToString()
Definition: XrdClFileOperations.hh:287
@ NamesArg
Definition: XrdClFileOperations.hh:1073
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:597
Visa operation (.
Definition: XrdClFileOperations.hh:723
#define open
Definition: XrdPosix.hh:71
@ SizeArg
Definition: XrdClFileOperations.hh:476
Request status.
Definition: XrdClXRootDResponses.hh:219
FcntlImpl< false > Fcntl
Definition: XrdClFileOperations.hh:716
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:451
std::vector< ChunkInfo > ChunkList
List of chunks.
Definition: XrdClXRootDResponses.hh:980
OpenImpl(OpenImpl< from > &&open)
Definition: XrdClFileOperations.hh:160
std::string ToString()
Definition: XrdClFileOperations.hh:437
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:250
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:1093
Read operation (.
Definition: XrdClFileOperations.hh:219
VectorWrite operation (.
Definition: XrdClFileOperations.hh:567
@ ForceArg
Definition: XrdClFileOperations.hh:326
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:748
@ NameArg
Definition: XrdClFileOperations.hh:1011
@ OffsetArg
Definition: XrdClFileOperations.hh:381
ReadImpl< false > Read(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
Factory for creating ReadImpl objects.
Definition: XrdClFileOperations.hh:264
@ OffsetArg
Definition: XrdClFileOperations.hh:625
WriteImpl< false > Write(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< const void * > buffer, uint16_t timeout=0)
Factory for creating WriteImpl objects.
Definition: XrdClFileOperations.hh:414
std::string ToString()
Definition: XrdClFileOperations.hh:536
VisaImpl< false > Visa
Definition: XrdClFileOperations.hh:755
Definition: XrdClFileOperations.hh:46
Helper class for unpacking single XAttr from bulk response.
Definition: XrdClOperationHandlers.hh:77
WriteVImpl< false > WriteV(Ctx< File > file, Arg< uint64_t > offset, Arg< std::vector< iovec >> iov, uint16_t timeout=0)
Factory for creating WriteVImpl objects.
Definition: XrdClFileOperations.hh:666
ExResp(const Ctx< File > &file)
Definition: XrdClFileOperations.hh:112
std::string ToString()
Definition: XrdClFileOperations.hh:843
std::string ToString()
Definition: XrdClFileOperations.hh:331
@ ValueArg
Definition: XrdClFileOperations.hh:775
bool IsOK() const
We're fine.
Definition: XrdClStatus.hh:122
Definition: XrdOucIOVec.hh:65
VectorReadImpl< false > VectorRead
Definition: XrdClFileOperations.hh:559
@ SizeArg
Definition: XrdClFileOperations.hh:231
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:708
ListXAttrImpl< false > ListXAttr(Ctx< File > file)
Definition: XrdClFileOperations.hh:1155
Lambda wrapper.
Definition: XrdClOperationHandlers.hh:312
@ NameArg
Definition: XrdClFileOperations.hh:775
Definition: XrdClAnyObject.hh:26
Fcntl operation (.
Definition: XrdClFileOperations.hh:678
std::string ToString()
Definition: XrdClFileOperations.hh:1128
FileOperation(FileOperation< Derived, from, Response, Arguments... > &&op)
Definition: XrdClFileOperations.hh:69
std::string ToString()
Definition: XrdClFileOperations.hh:583
VectorWriteImpl< false > VectorWrite
Definition: XrdClFileOperations.hh:605
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:201
@ OffsetArg
Definition: XrdClFileOperations.hh:231
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:1030
Ctx< File > file
The underlying XrdCl::File object.
Definition: XrdClFileOperations.hh:136
@ None
Definition: XrdClFileSystem.hh:123
Definition: XrdClArg.hh:233
DelXAttr bulk operation (.
Definition: XrdClFileOperations.hh:1061
Object stat info.
Definition: XrdClXRootDResponses.hh:400
@ BufferArg
Definition: XrdClFileOperations.hh:531
Sync operation (.
Definition: XrdClFileOperations.hh:426
@ BufferArg
Definition: XrdClFileOperations.hh:689
@ ChunksArg
Definition: XrdClFileOperations.hh:578
Binary blob representation.
Definition: XrdClBuffer.hh:34
DelXAttr operation (.
Definition: XrdClFileOperations.hh:1000
SyncImpl< false > Sync
Definition: XrdClFileOperations.hh:458
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:345
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:644
ListXAttr bulk operation (.
Definition: XrdClFileOperations.hh:1117
std::string ToString()
Definition: XrdClFileOperations.hh:1078
Helper class for unpacking single XAttrStatus from bulk response.
Definition: XrdClOperationHandlers.hh:42
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:1143
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition: XrdClFileOperations.hh:794
Flags
Open flags, may be or'd when appropriate.
Definition: XrdClFileSystem.hh:76
std::tuple< std::string, std::string > xattr_t
Extended attribute key - value pair.
Definition: XrdClXRootDResponses.hh:289
std::string ToString()
Definition: XrdClFileOperations.hh:630