XRootD
Loading...
Searching...
No Matches
XrdCl::FileOperation< Derived, HasHndl, Response, Arguments > Class Template Reference

#include <XrdClFileOperations.hh>

+ Inheritance diagram for XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >:
+ Collaboration diagram for XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >:

Public Member Functions

 FileOperation (Ctx< File > f, Arguments... args)
 
template<bool from>
 FileOperation (FileOperation< Derived, from, Response, Arguments... > &&op)
 
virtual ~FileOperation ()
 Destructor.
 
- Public Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >
 ConcreteOperation (Args &&... args)
 
 ConcreteOperation (ConcreteOperation< Derived, from, Response, Args... > &&op)
 
Operation< HasHndl > * Move ()
 
Derived< true > operator>> (Hdlr &&hdlr)
 
Derived< true > operator| (FinalOperation &&fo)
 Adds a final operation to the pipeline.
 
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.
 
Operation< true > * ToHandled ()
 
- Public Member Functions inherited from XrdCl::Operation< HasHndl >
 Operation ()
 Constructor.
 
template<bool from>
 Operation (Operation< from > &&op)
 Move constructor between template instances.
 
virtual ~Operation ()
 Destructor.
 
virtual std::string ToString ()=0
 Name of the operation.
 

Protected Attributes

Ctx< Filefile
 The file object itself.
 
- Protected Attributes inherited from XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >
std::tuple< Args... > args
 Operation arguments.
 
uint16_t timeout
 Operation timeout.
 
- Protected Attributes inherited from XrdCl::Operation< HasHndl >
std::unique_ptr< PipelineHandlerhandler
 Operation handler.
 
bool valid
 Flag indicating if it is a valid object.
 

Friends

template<template< bool > class, bool, typename, typename ...>
class FileOperation
 

Additional Inherited Members

- Protected Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >
Derived< true > StreamImpl (ResponseHandler *handler)
 
Derived< toTransform ()
 
- 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)
 
virtual XRootDStatus RunImpl (PipelineHandler *handler, uint16_t timeout)=0
 
- Static Protected Member Functions inherited from XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >
static void AllocHandler (ConcreteOperation< Derived, false, Response, Args... > &me)
 
static void AllocHandler (ConcreteOperation< Derived, true, Response, Args... > &me)
 
static Derived< true > PipeImpl (ConcreteOperation< Derived, HasHndl, Response, Args... > &me, Operation< false > &op)
 
static Derived< true > PipeImpl (ConcreteOperation< Derived, HasHndl, Response, Args... > &me, Operation< true > &op)
 

Detailed Description

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
class XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >

Base class for all file related operations

  • Derived : the class that derives from this template (CRTP)
  • HasHndl : true if operation has a handler, false otherwise
  • Args : operation arguments

Definition at line 45 of file XrdClFileOperations.hh.

Constructor & Destructor Documentation

◆ FileOperation() [1/2]

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >::FileOperation ( Ctx< File > f,
Arguments... args )
inline

Constructor

Parameters
f: file on which the operation will be performed
args: file operation arguments

Definition at line 57 of file XrdClFileOperations.hh.

References XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >::ConcreteOperation, XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >::args, and file.

+ Here is the call graph for this function:

◆ FileOperation() [2/2]

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
template<bool from>
XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >::FileOperation ( FileOperation< Derived, from, Response, Arguments... > && op)
inline

Move constructor from other states

  • from : state from which the object is being converted
Parameters
op: the object that is being converted

Definition at line 69 of file XrdClFileOperations.hh.

69 :
71 {
72
73 }

References XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >::ConcreteOperation, FileOperation, and file.

+ Here is the call graph for this function:

◆ ~FileOperation()

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
virtual XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >::~FileOperation ( )
inlinevirtual

Destructor.

Definition at line 78 of file XrdClFileOperations.hh.

79 {
80
81 }

Friends And Related Symbol Documentation

◆ FileOperation

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
template<template< bool > class, bool, typename, typename ...>
friend class FileOperation
friend

Definition at line 48 of file XrdClFileOperations.hh.

References FileOperation.

Referenced by FileOperation, and FileOperation().

Member Data Documentation

◆ file

template<template< bool > class Derived, bool HasHndl, typename Response, typename ... Arguments>
Ctx<File> XrdCl::FileOperation< Derived, HasHndl, Response, Arguments >::file
protected

The file object itself.

Definition at line 88 of file XrdClFileOperations.hh.

Referenced by FileOperation(), and FileOperation().


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