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>
131 using Resp<
void>::Create;
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 );
218 return OpenImpl<false>( std::move( file ), std::move( url ), std::move( flags ),
219 std::move( mode ) ).
Timeout( timeout );
225 template<
bool HasHndl>
227 Arg<uint64_t>, Arg<uint32_t>, Arg<void*>>
261 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
262 uint32_t size = std::get<SizeArg>( this->
args ).Get();
263 void *buffer = std::get<BufferArg>( this->
args ).Get();
264 uint16_t
timeout = pipelineTimeout < this->timeout ?
265 pipelineTimeout : this->
timeout;
276 return ReadImpl<false>( std::move( file ), std::move( offset ), std::move( size ),
277 std::move( buffer ) ).
Timeout( timeout );
283 template<
bool HasHndl>
285 Arg<uint64_t>, Arg<uint32_t>, Arg<void*>>
319 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
320 uint32_t size = std::get<SizeArg>( this->
args ).Get();
321 void *buffer = std::get<BufferArg>( this->
args ).Get();
322 uint16_t
timeout = pipelineTimeout < this->timeout ?
323 pipelineTimeout : this->
timeout;
333 uint16_t timeout = 0 )
335 return PgReadImpl<false>( std::move( file ), std::move( offset ), std::move( size ),
336 std::move( buffer ) ).
Timeout( timeout );
356 return Read( std::move( file ), std::move( offset ), std::move( size ),
357 std::move( buffer ), timeout );
360 template<>
inline PgReadImpl<false>
362 Arg<void*> buffer, uint16_t timeout )
364 return PgRead( std::move( file ), std::move( offset ), std::move( size ),
365 std::move( buffer ), timeout );
371 template<
bool HasHndl>
373 Arg<uint64_t>, Arg<uint32_t>, Arg<void*>, Arg<std::vector<uint32_t>>>
407 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
408 uint32_t size = std::get<SizeArg>( this->
args ).Get();
409 void *buffer = std::get<BufferArg>( this->
args ).Get();
410 std::vector<uint32_t> cksums = std::get<CksumsArg>( this->
args ).Get();
411 uint16_t
timeout = pipelineTimeout < this->timeout ?
412 pipelineTimeout : this->
timeout;
413 return this->file->PgWrite( offset, size, buffer, cksums,
handler,
timeout );
422 Arg<std::vector<uint32_t>> cksums,
423 uint16_t timeout = 0 )
426 std::move( buffer ), std::move( cksums ) ).
Timeout( timeout );
434 uint16_t timeout = 0 )
436 std::vector<uint32_t> cksums;
438 std::move( buffer ), std::move( cksums ) ).
Timeout( timeout );
444 template<
bool HasHndl>
473 uint16_t
timeout = pipelineTimeout < this->timeout ?
474 pipelineTimeout : this->
timeout;
490 template<
bool HasHndl>
524 bool force = std::get<ForceArg>( this->
args ).Get();
525 uint16_t
timeout = pipelineTimeout < this->timeout ?
526 pipelineTimeout : this->
timeout;
543 template<
bool HasHndl>
545 Arg<uint32_t>, Arg<const void*>>
579 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
580 uint32_t size = std::get<SizeArg>( this->
args ).Get();
581 const void *buffer = std::get<BufferArg>( this->
args ).Get();
582 uint16_t
timeout = pipelineTimeout < this->timeout ?
583 pipelineTimeout : this->
timeout;
584 return this->file->Write( offset, size, buffer,
handler,
timeout );
594 return WriteImpl<false>( std::move( file ), std::move( offset ), std::move( size ),
595 std::move( buffer ) ).
Timeout( timeout );
601 template<
bool HasHndl>
630 uint16_t
timeout = pipelineTimeout < this->timeout ?
631 pipelineTimeout : this->
timeout;
647 template<
bool HasHndl>
681 uint64_t size = std::get<SizeArg>( this->
args ).Get();
682 uint16_t
timeout = pipelineTimeout < this->timeout ?
683 pipelineTimeout : this->
timeout;
700 template<
bool HasHndl>
702 Resp<VectorReadInfo>, Arg<ChunkList>, Arg<void*>>
737 void *buffer = std::get<BufferArg>( this->
args ).Get();
738 uint16_t
timeout = pipelineTimeout < this->timeout ?
739 pipelineTimeout : this->
timeout;
740 return this->file->VectorRead( chunks, buffer,
handler,
timeout );
754 uint16_t timeout = 0 )
762 template<
bool HasHndl>
783 return "VectorWrite";
797 const ChunkList &chunks = std::get<ChunksArg>( this->
args ).Get();
798 uint16_t
timeout = pipelineTimeout < this->timeout ?
799 pipelineTimeout : this->
timeout;
808 uint16_t timeout = 0 )
816 template<
bool HasHndl>
818 Arg<std::vector<iovec>>>
852 uint64_t offset = std::get<OffsetArg>( this->
args ).Get();
853 std::vector<iovec> &stdiov = std::get<IovArg>( this->
args ).Get();
854 uint16_t
timeout = pipelineTimeout < this->timeout ?
855 pipelineTimeout : this->
timeout;
857 int iovcnt = stdiov.size();
859 for(
size_t i = 0; i < stdiov.size(); ++i )
861 iov[i].iov_base = stdiov[i].iov_base;
862 iov[i].iov_len = stdiov[i].iov_len;
873 Arg<std::vector<iovec>>
iov, uint16_t timeout = 0 )
882 template<
bool HasHndl>
916 Buffer &arg = std::get<BufferArg>( this->
args ).Get();
917 uint16_t
timeout = pipelineTimeout < this->timeout ?
918 pipelineTimeout : this->
timeout;
927 template<
bool HasHndl>
956 uint16_t
timeout = pipelineTimeout < this->timeout ?
957 pipelineTimeout : this->
timeout;
966 template<
bool HasHndl>
968 Arg<std::string>, Arg<std::string>>
988 return "SetXAttrImpl";
1002 std::string &name = std::get<NameArg>( this->
args ).Get();
1003 std::string &value = std::get<ValueArg>( this->
args ).Get();
1005 std::vector<xattr_t> attrs;
1006 attrs.push_back(
xattr_t( name, value ) );
1009 uint16_t
timeout = pipelineTimeout < this->timeout ?
1010 pipelineTimeout : this->
timeout;
1012 if( !st.
IsOK() )
delete h;
1029 template<
bool HasHndl>
1031 Resp<std::vector<XAttrStatus>>, Arg<std::vector<xattr_t>>>
1051 return "SetXAttrBulkImpl";
1066 std::vector<xattr_t> &attrs = std::get<AttrsArg>( this->
args ).Get();
1067 uint16_t
timeout = pipelineTimeout < this->timeout ?
1068 pipelineTimeout : this->
timeout;
1085 template<
bool HasHndl>
1107 return "GetXAttrImpl";
1121 std::string &name = std::get<NameArg>( this->
args ).Get();
1123 std::vector<std::string> attrs;
1124 attrs.push_back( name );
1127 uint16_t
timeout = pipelineTimeout < this->timeout ?
1128 pipelineTimeout : this->
timeout;
1130 if( !st.
IsOK() )
delete h;
1147 template<
bool HasHndl>
1149 Arg<std::vector<std::string>>>
1169 return "GetXAttrBulkImpl";
1184 std::vector<std::string> &attrs = std::get<NamesArg>( this->
args ).Get();
1185 uint16_t
timeout = pipelineTimeout < this->timeout ?
1186 pipelineTimeout : this->
timeout;
1203 template<
bool HasHndl>
1224 return "DelXAttrImpl";
1238 std::string &name = std::get<NameArg>( this->
args ).Get();
1240 std::vector<std::string> attrs;
1241 attrs.push_back( name );
1244 uint16_t
timeout = pipelineTimeout < this->timeout ?
1245 pipelineTimeout : this->
timeout;
1247 if( !st.
IsOK() )
delete h;
1264 template<
bool HasHndl>
1266 Resp<std::vector<XAttrStatus>>, Arg<std::vector<std::string>>>
1286 return "DelXAttrBulkImpl";
1301 std::vector<std::string> &attrs = std::get<NamesArg>( this->
args ).Get();
1302 uint16_t
timeout = pipelineTimeout < this->timeout ?
1303 pipelineTimeout : this->
timeout;
1320 template<
bool HasHndl>
1322 Resp<std::vector<XAttr>>>
1336 return "ListXAttrImpl";
1351 uint16_t
timeout = pipelineTimeout < this->timeout ?
1352 pipelineTimeout : this->
timeout;
#define open
Definition XrdPosix.hh:71
Definition XrdClArg.hh:234
Binary blob representation.
Definition XrdClBuffer.hh:34
Close operation (.
Definition XrdClFileOperations.hh:446
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:471
std::string ToString()
Definition XrdClFileOperations.hh:457
Definition XrdClOperations.hh:552
std::tuple< Args... > args
Operation arguments.
Definition XrdClOperations.hh:771
Derived< HasHndl > Timeout(uint16_t timeout)
Set operation timeout.
Definition XrdClOperations.hh:681
uint16_t timeout
Operation timeout.
Definition XrdClOperations.hh:776
DelXAttr bulk operation (.
Definition XrdClFileOperations.hh:1267
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1299
@ NamesArg
Definition XrdClFileOperations.hh:1279
std::string ToString()
Definition XrdClFileOperations.hh:1284
DelXAttr operation (.
Definition XrdClFileOperations.hh:1206
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1236
@ NameArg
Definition XrdClFileOperations.hh:1217
std::string ToString()
Definition XrdClFileOperations.hh:1222
Lambda wrapper.
Definition XrdClOperationHandlers.hh:336
Fcntl operation (.
Definition XrdClFileOperations.hh:884
std::string ToString()
Definition XrdClFileOperations.hh:900
@ BufferArg
Definition XrdClFileOperations.hh:895
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:914
Definition XrdClFileOperations.hh:46
FileOperation(Ctx< File > f, Arguments... args)
Definition XrdClFileOperations.hh:57
virtual ~FileOperation()
Destructor.
Definition XrdClFileOperations.hh:78
FileOperation(FileOperation< Derived, from, Response, Arguments... > &&op)
Definition XrdClFileOperations.hh:69
friend class FileOperation
Definition XrdClFileOperations.hh:48
Ctx< File > file
The file object itself.
Definition XrdClFileOperations.hh:88
GetXAttr bulk operation (.
Definition XrdClFileOperations.hh:1150
std::string ToString()
Definition XrdClFileOperations.hh:1167
@ NamesArg
Definition XrdClFileOperations.hh:1162
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1182
GetXAttr operation (.
Definition XrdClFileOperations.hh:1088
std::string ToString()
Definition XrdClFileOperations.hh:1105
@ NameArg
Definition XrdClFileOperations.hh:1100
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1119
ListXAttr bulk operation (.
Definition XrdClFileOperations.hh:1323
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1349
std::string ToString()
Definition XrdClFileOperations.hh:1334
Open operation (.
Definition XrdClFileOperations.hh:97
@ FlagsArg
Definition XrdClFileOperations.hh:170
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:201
OpenImpl(OpenImpl< from > &&open)
Definition XrdClFileOperations.hh:160
OpenImpl< true > operator>>(Hdlr &&hdlr)
Definition XrdClFileOperations.hh:179
std::string ToString()
Definition XrdClFileOperations.hh:188
OpenImpl(Ctx< File > f, Arg< std::string > url, Arg< OpenFlags::Flags > flags, Arg< Access::Mode > mode=Access::None)
Constructor (.
Definition XrdClFileOperations.hh:144
std::unique_ptr< PipelineHandler > handler
Operation handler.
Definition XrdClOperations.hh:309
PgRead operation (.
Definition XrdClFileOperations.hh:286
std::string ToString()
Definition XrdClFileOperations.hh:303
@ SizeArg
Definition XrdClFileOperations.hh:298
@ BufferArg
Definition XrdClFileOperations.hh:298
@ OffsetArg
Definition XrdClFileOperations.hh:298
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:317
PgWrite operation (.
Definition XrdClFileOperations.hh:374
std::string ToString()
Definition XrdClFileOperations.hh:391
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:405
@ BufferArg
Definition XrdClFileOperations.hh:386
@ SizeArg
Definition XrdClFileOperations.hh:386
@ CksumsArg
Definition XrdClFileOperations.hh:386
@ OffsetArg
Definition XrdClFileOperations.hh:386
Definition XrdClOperations.hh:64
Read operation (.
Definition XrdClFileOperations.hh:228
@ BufferArg
Definition XrdClFileOperations.hh:240
@ OffsetArg
Definition XrdClFileOperations.hh:240
@ SizeArg
Definition XrdClFileOperations.hh:240
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:259
std::string ToString()
Definition XrdClFileOperations.hh:245
Handle an async response.
Definition XrdClXRootDResponses.hh:1126
SetXAttr bulk operation (.
Definition XrdClFileOperations.hh:1032
@ AttrsArg
Definition XrdClFileOperations.hh:1044
std::string ToString()
Definition XrdClFileOperations.hh:1049
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1064
SetXAttr operation (.
Definition XrdClFileOperations.hh:969
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:1000
std::string ToString()
Definition XrdClFileOperations.hh:986
@ ValueArg
Definition XrdClFileOperations.hh:981
@ NameArg
Definition XrdClFileOperations.hh:981
Stat operation (.
Definition XrdClFileOperations.hh:492
@ ForceArg
Definition XrdClFileOperations.hh:503
std::string ToString()
Definition XrdClFileOperations.hh:508
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:522
Object stat info.
Definition XrdClXRootDResponses.hh:400
Sync operation (.
Definition XrdClFileOperations.hh:603
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:628
std::string ToString()
Definition XrdClFileOperations.hh:614
Truncate operation (.
Definition XrdClFileOperations.hh:649
std::string ToString()
Definition XrdClFileOperations.hh:665
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:679
@ SizeArg
Definition XrdClFileOperations.hh:660
Helper class for unpacking single XAttrStatus from bulk response.
Definition XrdClOperationHandlers.hh:42
Helper class for unpacking single XAttr from bulk response.
Definition XrdClOperationHandlers.hh:77
VectorRead operation (.
Definition XrdClFileOperations.hh:703
@ ChunksArg
Definition XrdClFileOperations.hh:715
@ BufferArg
Definition XrdClFileOperations.hh:715
std::string ToString()
Definition XrdClFileOperations.hh:720
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:734
VectorWrite operation (.
Definition XrdClFileOperations.hh:765
@ ChunksArg
Definition XrdClFileOperations.hh:776
std::string ToString()
Definition XrdClFileOperations.hh:781
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:795
Visa operation (.
Definition XrdClFileOperations.hh:929
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:954
std::string ToString()
Definition XrdClFileOperations.hh:940
Write operation (.
Definition XrdClFileOperations.hh:546
std::string ToString()
Definition XrdClFileOperations.hh:563
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:577
@ SizeArg
Definition XrdClFileOperations.hh:558
@ OffsetArg
Definition XrdClFileOperations.hh:558
@ BufferArg
Definition XrdClFileOperations.hh:558
WriteV operation (.
Definition XrdClFileOperations.hh:819
@ OffsetArg
Definition XrdClFileOperations.hh:831
@ IovArg
Definition XrdClFileOperations.hh:831
std::string ToString()
Definition XrdClFileOperations.hh:836
XRootDStatus RunImpl(PipelineHandler *handler, uint16_t pipelineTimeout)
Definition XrdClFileOperations.hh:850
Request status.
Definition XrdClXRootDResponses.hh:219
Definition XrdClAction.hh:34
VectorWriteImpl< false > VectorWrite(Ctx< File > file, Arg< ChunkList > chunks, uint16_t timeout=0)
Factory for creating VectorWriteImpl objects.
Definition XrdClFileOperations.hh:807
GetXAttrImpl< false > GetXAttr(Ctx< File > file, Arg< std::string > name)
Definition XrdClFileOperations.hh:1139
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:273
ReadImpl< false > RdWithRsp< ChunkInfo >(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout)
Definition XrdClFileOperations.hh:353
SyncImpl< false > Sync(Ctx< File > file, uint16_t timeout=0)
Factory for creating SyncImpl objects.
Definition XrdClFileOperations.hh:639
StatImpl< false > Stat(Ctx< File > file, Arg< bool > force, uint16_t timeout=0)
Definition XrdClFileOperations.hh:535
CloseImpl< false > Close(Ctx< File > file, uint16_t timeout=0)
Factory for creating CloseImpl objects.
Definition XrdClFileOperations.hh:482
DelXAttrImpl< false > DelXAttr(Ctx< File > file, Arg< std::string > name)
Definition XrdClFileOperations.hh:1256
TruncateImpl< false > Truncate(Ctx< File > file, Arg< uint64_t > size, uint16_t timeout)
Definition XrdClFileOperations.hh:692
FcntlImpl< false > Fcntl
Definition XrdClFileOperations.hh:922
PgReadImpl< false > PgRead(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
Factory for creating PgReadImpl objects.
Definition XrdClFileOperations.hh:331
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:872
VisaImpl< false > Visa
Definition XrdClFileOperations.hh:961
SetXAttrImpl< false > SetXAttr(Ctx< File > file, Arg< std::string > name, Arg< std::string > value)
Definition XrdClFileOperations.hh:1021
ListXAttrImpl< false > ListXAttr(Ctx< File > file)
Definition XrdClFileOperations.hh:1361
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:591
PgReadImpl< false > RdWithRsp< PageInfo >(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout)
Definition XrdClFileOperations.hh:361
std::tuple< std::string, std::string > xattr_t
Extended attribute key - value pair.
Definition XrdClXRootDResponses.hh:289
ReadTrait< RSP >::RET RdWithRsp(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, uint16_t timeout=0)
PgWriteImpl< false > PgWrite(Ctx< File > file, Arg< uint64_t > offset, Arg< uint32_t > size, Arg< void * > buffer, Arg< std::vector< uint32_t > > cksums, uint16_t timeout=0)
Factory for creating PgReadImpl objects.
Definition XrdClFileOperations.hh:420
std::vector< ChunkInfo > ChunkList
List of chunks.
Definition XrdClXRootDResponses.hh:1055
VectorReadImpl< false > VectorRead(Ctx< File > file, Arg< ChunkList > chunks, Arg< void * > buffer, uint16_t timeout=0)
Factory for creating VectorReadImpl objects.
Definition XrdClFileOperations.hh:747
OpenImpl< false > Open(Ctx< File > file, Arg< std::string > url, Arg< OpenFlags::Flags > flags, Arg< Access::Mode > mode=Access::None, uint16_t timeout=0)
Factory for creating ReadImpl objects.
Definition XrdClFileOperations.hh:215
Definition XrdOucJson.hh:4517
Access mode.
Definition XrdClFileSystem.hh:117
Mode
Access mode.
Definition XrdClFileSystem.hh:122
@ None
Definition XrdClFileSystem.hh:123
Describe a data chunk for vector read.
Definition XrdClXRootDResponses.hh:917
Utility class for storing a pointer to operation context.
Definition XrdClCtx.hh:39
Open flags, may be or'd when appropriate.
Definition XrdClFileSystem.hh:71
Flags
Open flags, may be or'd when appropriate.
Definition XrdClFileSystem.hh:76
Definition XrdClFileOperations.hh:106
Ctx< File > file
The underlying XrdCl::File object.
Definition XrdClFileOperations.hh:136
ResponseHandler * Create(std::function< void(XRootDStatus &, StatInfo &)> func)
Definition XrdClFileOperations.hh:122
ExResp(const Ctx< File > &file)
Definition XrdClFileOperations.hh:112
Definition XrdClXRootDResponses.hh:956
RdWithRsp: factory for creating ReadImpl/PgReadImpl objects.
Definition XrdClFileOperations.hh:342
Definition XrdClOperationHandlers.hh:662
bool IsOK() const
We're fine.
Definition XrdClStatus.hh:124
Definition XrdOucIOVec.hh:65