XRootD
XrdCl::DirListImpl< HasHndl > Class Template Reference

DirList operation (. More...

#include <XrdClFileSystemOperations.hh>

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

Public Types

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

Public Member Functions

std::string ToString ()
 
- Public Member Functions inherited from XrdCl::FileSystemOperation< DirListImpl, HasHndl, Resp< DirectoryList >, Arg< std::string >, Arg< DirListFlags::Flags > >
 FileSystemOperation (Ctx< FileSystem > fs, Args... args)
 
 FileSystemOperation (FileSystemOperation< DirListImpl, from, Resp< DirectoryList >, 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< DirListImpl, HasHndl, Resp< DirectoryList >, Arg< std::string >, Arg< DirListFlags::Flags > >
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::DirListImpl< HasHndl >

DirList operation (.

See also
FileSystemOperation)

Definition at line 704 of file XrdClFileSystemOperations.hh.

Member Enumeration Documentation

◆ anonymous enum

template<bool HasHndl>
anonymous enum

Argument indexes in the args tuple.

Enumerator
PathArg 
FlagsArg 

Definition at line 718 of file XrdClFileSystemOperations.hh.

◆ Flags

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

Definition at line 155 of file XrdClFileSystem.hh.

156  {
157  None = 0,
158  Stat = 1,
159  Locate = 2,
161  Recursive = 4,
162  Merge = 8,
163  Chunked = 16,
164  Zip = 32,
165  Cksm = 64
166  };
StatImpl< false > Stat(Ctx< File > file, Arg< bool > force, uint16_t timeout=0)
LocateImpl< false > Locate

Member Function Documentation

◆ RunImpl()

template<bool HasHndl>
XRootDStatus XrdCl::DirListImpl< 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 737 of file XrdClFileSystemOperations.hh.

738  {
739  std::string &path = std::get<PathArg>( this->args ).Get();
740  DirListFlags::Flags flags = std::get<FlagsArg>( this->args ).Get();
741  uint16_t timeout = pipelineTimeout < this->timeout ?
742  pipelineTimeout : this->timeout;
743  return this->filesystem->DirList( path, flags, handler, timeout );
744  }
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< DirListImpl, HasHndl, Resp< DirectoryList >, Arg< std::string >, Arg< DirListFlags::Flags > >::filesystem, XrdCl::Operation< HasHndl >::handler, and XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::timeout.

◆ ToString()

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

Implements XrdCl::Operation< HasHndl >.

Definition at line 723 of file XrdClFileSystemOperations.hh.

724  {
725  return "DirList";
726  }

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