XRootD
XrdCl::PrepareImpl< HasHndl > Class Template Reference

Prepare operation (. More...

#include <XrdClFileSystemOperations.hh>

+ Inheritance diagram for XrdCl::PrepareImpl< HasHndl >:
+ Collaboration diagram for XrdCl::PrepareImpl< HasHndl >:

Public Types

enum  {
  FileListArg ,
  FlagsArg ,
  PriorityArg
}
 Argument indexes in the args tuple. More...
 
enum  Flags
 

Public Member Functions

std::string ToString ()
 
- Public Member Functions inherited from XrdCl::FileSystemOperation< PrepareImpl, HasHndl, Resp< Buffer >, Arg< std::vector< std::string > >, Arg< PrepareFlags::Flags >, Arg< uint8_t > >
 FileSystemOperation (Ctx< FileSystem > fs, Args... args)
 
 FileSystemOperation (FileSystemOperation< PrepareImpl, from, Resp< Buffer >, Args... > &&op)
 
virtual ~FileSystemOperation ()
 Destructor. More...
 
- Public Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >
 ConcreteOperation (Args &&... args)
 
template<bool from>
 ConcreteOperation (ConcreteOperation< Derived, from, HdlrFactory, Args... > &&op)
 
Operation< HasHndl > * Move ()
 
template<typename Hdlr >
Derived< true > operator>> (Hdlr &&hdlr)
 
Derived< true > operator| (FinalOperation &&fo)
 Adds a final operation to the pipeline. More...
 
Derived< true > operator| (Operation< false > &&op)
 
Derived< true > operator| (Operation< false > &op)
 
Derived< true > operator| (Operation< true > &&op)
 
Derived< true > operator| (Operation< true > &op)
 
Derived< HasHndl > Timeout (uint16_t timeout)
 Set operation timeout. More...
 
Operation< true > * ToHandled ()
 
- Public Member Functions inherited from XrdCl::Operation< HasHndl >
 Operation ()
 Constructor. More...
 
template<bool from>
 Operation (Operation< from > &&op)
 Move constructor between template instances. More...
 
virtual ~Operation ()
 Destructor. More...
 

Protected Member Functions

XRootDStatus RunImpl (PipelineHandler *handler, uint16_t pipelineTimeout)
 
- Protected Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >
Derived< true > StreamImpl (ResponseHandler *handler)
 
template<bool to>
Derived< to > Transform ()
 
- Protected Member Functions inherited from XrdCl::Operation< HasHndl >
void AddOperation (Operation< true > *op)
 
void Run (Timeout timeout, std::promise< XRootDStatus > prms, std::function< void(const XRootDStatus &)> final)
 

Additional Inherited Members

- Static Protected Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >
static void AllocHandler (ConcreteOperation< Derived, false, HdlrFactory, Args... > &me)
 
static void AllocHandler (ConcreteOperation< Derived, true, HdlrFactory, Args... > &me)
 
static Derived< true > PipeImpl (ConcreteOperation< Derived, HasHndl, HdlrFactory, Args... > &me, Operation< false > &op)
 
static Derived< true > PipeImpl (ConcreteOperation< Derived, HasHndl, HdlrFactory, Args... > &me, Operation< true > &op)
 
- Protected Attributes inherited from XrdCl::FileSystemOperation< PrepareImpl, HasHndl, Resp< Buffer >, Arg< std::vector< std::string > >, Arg< PrepareFlags::Flags >, Arg< uint8_t > >
Ctx< FileSystemfilesystem
 The file system object itself. More...
 
- Protected Attributes inherited from XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >
std::tuple< Args... > args
 Operation arguments. More...
 
uint16_t timeout
 Operation timeout. More...
 
- Protected Attributes inherited from XrdCl::Operation< HasHndl >
std::unique_ptr< PipelineHandlerhandler
 Operation handler. More...
 
bool valid
 Flag indicating if it is a valid object. More...
 

Detailed Description

template<bool HasHndl>
class XrdCl::PrepareImpl< HasHndl >

Prepare operation (.

See also
FileSystemOperation)

Definition at line 799 of file XrdClFileSystemOperations.hh.

Member Enumeration Documentation

◆ anonymous enum

template<bool HasHndl>
anonymous enum

Argument indexes in the args tuple.

Enumerator
FileListArg 
FlagsArg 
PriorityArg 

Definition at line 813 of file XrdClFileSystemOperations.hh.

◆ Flags

template<bool HasHndl>
enum XrdCl::PrepareFlags::Flags

Definition at line 175 of file XrdClFileSystem.hh.

176  {
177  None = 0,
178  Colocate = kXR_coloc,
179  Fresh = kXR_fresh,
181  Stage = kXR_stage,
183  WriteMode = kXR_wmode,
185  Cancel = kXR_cancel,
186  Evict = kXR_evict << 8
190  };
@ kXR_wmode
Definition: XProtocol.hh:591
@ kXR_evict
Definition: XProtocol.hh:596
@ kXR_cancel
Definition: XProtocol.hh:587
@ kXR_fresh
Definition: XProtocol.hh:593
@ kXR_coloc
Definition: XProtocol.hh:592
@ kXR_stage
Definition: XProtocol.hh:590

Member Function Documentation

◆ RunImpl()

template<bool HasHndl>
XRootDStatus XrdCl::PrepareImpl< HasHndl >::RunImpl ( PipelineHandler handler,
uint16_t  pipelineTimeout 
)
inlineprotectedvirtual

RunImpl operation (

See also
Operation)
Parameters
params: container with parameters forwarded from previous operation
Returns
: status of the operation

Implements XrdCl::Operation< HasHndl >.

Definition at line 832 of file XrdClFileSystemOperations.hh.

833  {
834  std::vector<std::string> &fileList = std::get<FileListArg>( this->args ).Get();
835  PrepareFlags::Flags flags = std::get<FlagsArg>( this->args ).Get();
836  uint8_t priority = std::get<PriorityArg>( this->args ).Get();
837  uint16_t timeout = pipelineTimeout < this->timeout ?
838  pipelineTimeout : this->timeout;
839  return this->filesystem->Prepare( fileList, flags, priority,
840  handler, timeout );
841  }
std::tuple< Args... > args
Operation arguments.
uint16_t timeout
Operation timeout.
std::unique_ptr< PipelineHandler > handler
Operation handler.

References XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::args, XrdCl::FileSystemOperation< PrepareImpl, HasHndl, Resp< Buffer >, Arg< std::vector< std::string > >, Arg< PrepareFlags::Flags >, Arg< uint8_t > >::filesystem, XrdCl::Operation< HasHndl >::handler, and XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::timeout.

◆ ToString()

template<bool HasHndl>
std::string XrdCl::PrepareImpl< HasHndl >::ToString ( )
inlinevirtual
Returns
: name of the operation (
See also
Operation)

Implements XrdCl::Operation< HasHndl >.

Definition at line 818 of file XrdClFileSystemOperations.hh.

819  {
820  return "Prepare";
821  }

The documentation for this class was generated from the following file: