XRootD
XrdCl::Operation< HasHndl > Class Template Referenceabstract

#include <XrdClOperations.hh>

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

Public Member Functions

 Operation ()
 Constructor. More...
 
template<bool from>
 Operation (Operation< from > &&op)
 Move constructor between template instances. More...
 
virtual ~Operation ()
 Destructor. More...
 
virtual Operation< HasHndl > * Move ()=0
 
virtual Operation< true > * ToHandled ()=0
 
virtual std::string ToString ()=0
 Name of the operation. More...
 

Protected Member Functions

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
 

Protected Attributes

std::unique_ptr< PipelineHandlerhandler
 Operation handler. More...
 
bool valid
 Flag indicating if it is a valid object. More...
 

Friends

template<bool >
class Operation
 
std::future< XRootDStatusAsync (Pipeline, uint16_t)
 
class Pipeline
 
class PipelineHandler
 

Detailed Description

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

Operation template. An Operation is a once-use-only object - once executed by a Workflow engine it is invalidated. Also if used as an argument for

or | the original object gets invalidated.

  • HasHndl : true if operation has a handler, false otherwise

Definition at line 187 of file XrdClOperations.hh.

Constructor & Destructor Documentation

◆ Operation() [1/2]

template<bool HasHndl>
XrdCl::Operation< HasHndl >::Operation ( )
inline

Constructor.

Definition at line 203 of file XrdClOperations.hh.

203  : valid( true )
204  {
205  }
bool valid
Flag indicating if it is a valid object.

◆ Operation() [2/2]

template<bool HasHndl>
template<bool from>
XrdCl::Operation< HasHndl >::Operation ( Operation< from > &&  op)
inline

Move constructor between template instances.

Definition at line 211 of file XrdClOperations.hh.

211  :
212  handler( std::move( op.handler ) ), valid( true )
213  {
214  if( !op.valid ) throw std::invalid_argument( "Cannot construct "
215  "Operation from an invalid Operation!" );
216  op.valid = false;
217  }
std::unique_ptr< PipelineHandler > handler
Operation handler.

◆ ~Operation()

template<bool HasHndl>
virtual XrdCl::Operation< HasHndl >::~Operation ( )
inlinevirtual

Destructor.

Definition at line 222 of file XrdClOperations.hh.

223  {
224  }

Member Function Documentation

◆ AddOperation()

template<bool HasHndl>
void XrdCl::Operation< HasHndl >::AddOperation ( Operation< true > *  op)
inlineprotected

Add next operation in the pipeline

Parameters
op: operation to add

Definition at line 300 of file XrdClOperations.hh.

301  {
302  if( handler )
303  handler->AddOperation( op );
304  }

References XrdCl::Operation< HasHndl >::handler.

◆ Move()

template<bool HasHndl>
virtual Operation<HasHndl>* XrdCl::Operation< HasHndl >::Move ( )
pure virtual

Move current object into newly allocated instance

Returns
: the new instance

Implemented in XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >, XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >, XrdCl::ConcreteOperation< ParallelOperation, HasHndl, Resp< void > >, and XrdCl::ConcreteOperation< Derived, HasHndl, Response, Args... >.

Referenced by XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::PipeImpl().

+ Here is the caller graph for this function:

◆ Run()

template<bool HasHndl>
void XrdCl::Operation< HasHndl >::Run ( Timeout  timeout,
std::promise< XRootDStatus prms,
std::function< void(const XRootDStatus &)>  final 
)
inlineprotected

Run operation

Parameters
prms: the promise that we will have a result
final: the object to call at the end of pipeline

Definition at line 254 of file XrdClOperations.hh.

257  {
258  static_assert(HasHndl, "Only an operation that has a handler can be assigned to workflow");
259  handler->Assign( timeout, std::move( prms ), std::move( final ), this );
260 
261  PipelineHandler *h = handler.release();
262  XRootDStatus st;
263  try
264  {
265  st = RunImpl( h, timeout );
266  }
267  catch( const operation_expired& ex )
268  {
269  st = XRootDStatus( stError, errOperationExpired );
270  }
271  catch( const PipelineException& ex ) // probably not needed
272  {
273  st = ex.GetError();
274  }
275  catch( const std::exception& ex )
276  {
277  st = XRootDStatus( stError, errInternal, 0, ex.what() );
278  }
279 
280  if( !st.IsOK() ){
281  ResponseJob *job = new ResponseJob(h, new XRootDStatus(st), 0, nullptr);
283  }
284  }
static PostMaster * GetPostMaster()
Get default post master.
void QueueJob(Job *job, void *arg=0)
Add a job to be run.
friend class PipelineHandler
virtual XRootDStatus RunImpl(PipelineHandler *handler, uint16_t timeout)=0
JobManager * GetJobManager()
Get the job manager object user by the post master.
const uint16_t errOperationExpired
Definition: XrdClStatus.hh:90
const uint16_t stError
An error occurred that could potentially be retried.
Definition: XrdClStatus.hh:32
const uint16_t errInternal
Internal error.
Definition: XrdClStatus.hh:56

References XrdCl::errInternal, XrdCl::errOperationExpired, XrdCl::PostMaster::GetJobManager(), XrdCl::DefaultEnv::GetPostMaster(), XrdCl::Operation< HasHndl >::handler, XrdCl::Status::IsOK(), XrdCl::JobManager::QueueJob(), XrdCl::Operation< HasHndl >::RunImpl(), and XrdCl::stError.

+ Here is the call graph for this function:

◆ RunImpl()

template<bool HasHndl>
virtual XRootDStatus XrdCl::Operation< HasHndl >::RunImpl ( PipelineHandler handler,
uint16_t  timeout 
)
protectedpure virtual

Run the actual operation

Parameters
params: container with parameters forwarded from previous operation
Returns
: status of the operation

Implemented in XrdEc::OpenOnlyImpl< HasHndl >, XrdCl::CloseArchiveImpl< HasHndl >, XrdCl::ZipListImpl< HasHndl >, XrdCl::ZipStatImpl< HasHndl >, XrdCl::CloseFileImpl< HasHndl >, XrdCl::AppendFileImpl< HasHndl >, XrdCl::ZipWriteImpl< HasHndl >, XrdCl::ZipReadFromImpl< HasHndl >, XrdCl::ZipReadImpl< HasHndl >, XrdCl::OpenFileImpl< HasHndl >, XrdCl::OpenArchiveImpl< HasHndl >, XrdCl::ListXAttrFsImpl< HasHndl >, XrdCl::DelXAttrFsBulkImpl< HasHndl >, XrdCl::DelXAttrFsImpl< HasHndl >, XrdCl::GetXAttrFsBulkImpl< HasHndl >, XrdCl::GetXAttrFsImpl< HasHndl >, XrdCl::SetXAttrFsBulkImpl< HasHndl >, XrdCl::SetXAttrFsImpl< HasHndl >, XrdCl::PrepareImpl< HasHndl >, XrdCl::SendInfoImpl< HasHndl >, XrdCl::DirListImpl< HasHndl >, XrdCl::ProtocolImpl< HasHndl >, XrdCl::StatVFSImpl< HasHndl >, XrdCl::StatFsImpl< HasHndl >, XrdCl::PingImpl< HasHndl >, XrdCl::ChModImpl< HasHndl >, XrdCl::RmDirImpl< HasHndl >, XrdCl::MkDirImpl< HasHndl >, XrdCl::RmImpl< HasHndl >, XrdCl::TruncateFsImpl< HasHndl >, XrdCl::QueryImpl< HasHndl >, XrdCl::MvImpl< HasHndl >, XrdCl::DeepLocateImpl< HasHndl >, XrdCl::LocateImpl< HasHndl >, XrdCl::ListXAttrImpl< HasHndl >, XrdCl::DelXAttrBulkImpl< HasHndl >, XrdCl::DelXAttrImpl< HasHndl >, XrdCl::GetXAttrBulkImpl< HasHndl >, XrdCl::GetXAttrImpl< HasHndl >, XrdCl::SetXAttrBulkImpl< HasHndl >, XrdCl::SetXAttrImpl< HasHndl >, XrdCl::VisaImpl< HasHndl >, XrdCl::FcntlImpl< HasHndl >, XrdCl::WriteVImpl< HasHndl >, XrdCl::VectorWriteImpl< HasHndl >, XrdCl::VectorReadImpl< HasHndl >, XrdCl::TruncateImpl< HasHndl >, XrdCl::SyncImpl< HasHndl >, XrdCl::WriteImpl< HasHndl >, XrdCl::StatImpl< HasHndl >, XrdCl::CloseImpl< HasHndl >, XrdCl::PgWriteImpl< HasHndl >, XrdCl::PgReadImpl< HasHndl >, XrdCl::ReadImpl< HasHndl >, XrdCl::OpenImpl< HasHndl >, XrdCl::ChkptWrtVImpl< HasHndl >, XrdCl::ChkptWrtImpl< HasHndl >, and XrdCl::CheckpointImpl< HasHndl >.

Referenced by XrdCl::Operation< HasHndl >::Run().

+ Here is the caller graph for this function:

◆ ToHandled()

template<bool HasHndl>
virtual Operation<true>* XrdCl::Operation< HasHndl >::ToHandled ( )
pure virtual

Move current object into newly allocated instance, and convert it into 'handled' operation.

Returns
: the new instance

Implemented in XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >, XrdCl::ConcreteOperation< Derived, HasHndl, Response, Arguments... >, XrdCl::ConcreteOperation< ParallelOperation, HasHndl, Resp< void > >, and XrdCl::ConcreteOperation< Derived, HasHndl, Response, Args... >.

Referenced by XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::PipeImpl().

+ Here is the caller graph for this function:

◆ ToString()

template<bool HasHndl>
virtual std::string XrdCl::Operation< HasHndl >::ToString ( )
pure virtual

Name of the operation.

Implemented in XrdEc::OpenOnlyImpl< HasHndl >, XrdCl::CloseArchiveImpl< HasHndl >, XrdCl::ZipListImpl< HasHndl >, XrdCl::ZipStatImpl< HasHndl >, XrdCl::CloseFileImpl< HasHndl >, XrdCl::AppendFileImpl< HasHndl >, XrdCl::ZipWriteImpl< HasHndl >, XrdCl::ZipReadFromImpl< HasHndl >, XrdCl::ZipReadImpl< HasHndl >, XrdCl::OpenFileImpl< HasHndl >, XrdCl::OpenArchiveImpl< HasHndl >, XrdCl::ParallelOperation< HasHndl >, XrdCl::ListXAttrFsImpl< HasHndl >, XrdCl::DelXAttrFsBulkImpl< HasHndl >, XrdCl::DelXAttrFsImpl< HasHndl >, XrdCl::GetXAttrFsBulkImpl< HasHndl >, XrdCl::GetXAttrFsImpl< HasHndl >, XrdCl::SetXAttrFsBulkImpl< HasHndl >, XrdCl::SetXAttrFsImpl< HasHndl >, XrdCl::PrepareImpl< HasHndl >, XrdCl::SendInfoImpl< HasHndl >, XrdCl::DirListImpl< HasHndl >, XrdCl::ProtocolImpl< HasHndl >, XrdCl::StatVFSImpl< HasHndl >, XrdCl::StatFsImpl< HasHndl >, XrdCl::PingImpl< HasHndl >, XrdCl::ChModImpl< HasHndl >, XrdCl::RmDirImpl< HasHndl >, XrdCl::MkDirImpl< HasHndl >, XrdCl::RmImpl< HasHndl >, XrdCl::TruncateFsImpl< HasHndl >, XrdCl::QueryImpl< HasHndl >, XrdCl::MvImpl< HasHndl >, XrdCl::DeepLocateImpl< HasHndl >, XrdCl::LocateImpl< HasHndl >, XrdCl::ListXAttrImpl< HasHndl >, XrdCl::DelXAttrBulkImpl< HasHndl >, XrdCl::DelXAttrImpl< HasHndl >, XrdCl::GetXAttrBulkImpl< HasHndl >, XrdCl::GetXAttrImpl< HasHndl >, XrdCl::SetXAttrBulkImpl< HasHndl >, XrdCl::SetXAttrImpl< HasHndl >, XrdCl::VisaImpl< HasHndl >, XrdCl::FcntlImpl< HasHndl >, XrdCl::WriteVImpl< HasHndl >, XrdCl::VectorWriteImpl< HasHndl >, XrdCl::VectorReadImpl< HasHndl >, XrdCl::TruncateImpl< HasHndl >, XrdCl::SyncImpl< HasHndl >, XrdCl::WriteImpl< HasHndl >, XrdCl::StatImpl< HasHndl >, XrdCl::CloseImpl< HasHndl >, XrdCl::PgWriteImpl< HasHndl >, XrdCl::PgReadImpl< HasHndl >, XrdCl::ReadImpl< HasHndl >, XrdCl::OpenImpl< HasHndl >, XrdCl::ChkptWrtVImpl< HasHndl >, XrdCl::ChkptWrtImpl< HasHndl >, and XrdCl::CheckpointImpl< HasHndl >.

Friends And Related Function Documentation

◆ Operation

template<bool HasHndl>
template<bool >
friend class Operation
friend

Definition at line 191 of file XrdClOperations.hh.

◆ Async

template<bool HasHndl>
std::future<XRootDStatus> Async ( Pipeline  pipeline,
uint16_t  timeout = 0 
)
friend

Helper function, schedules execution of given pipeline

Parameters
pipeline: the pipeline to be executed
timeout: the pipeline timeout
Returns
: future status of the operation

Definition at line 522 of file XrdClOperations.hh.

523  {
524  pipeline.Run( timeout );
525  return std::move( pipeline.ftr );
526  }

◆ Pipeline

template<bool HasHndl>
friend class Pipeline
friend

Definition at line 195 of file XrdClOperations.hh.

◆ PipelineHandler

Member Data Documentation

◆ handler

template<bool HasHndl>
std::unique_ptr<PipelineHandler> XrdCl::Operation< HasHndl >::handler
protected

Operation handler.

Definition at line 309 of file XrdClOperations.hh.

Referenced by XrdCl::Operation< HasHndl >::AddOperation(), XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::AllocHandler(), XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::operator|(), XrdCl::ZipArchive::PgRead(), XrdCl::PipelineHandler::PreparePipelineStart(), XrdCl::ZipArchive::Read(), XrdCl::Operation< HasHndl >::Run(), XrdCl::CheckpointImpl< HasHndl >::RunImpl(), XrdCl::ChkptWrtImpl< HasHndl >::RunImpl(), XrdCl::ChkptWrtVImpl< HasHndl >::RunImpl(), XrdCl::ReadImpl< HasHndl >::RunImpl(), XrdCl::PgReadImpl< HasHndl >::RunImpl(), XrdCl::PgWriteImpl< HasHndl >::RunImpl(), XrdCl::CloseImpl< HasHndl >::RunImpl(), XrdCl::StatImpl< HasHndl >::RunImpl(), XrdCl::WriteImpl< HasHndl >::RunImpl(), XrdCl::SyncImpl< HasHndl >::RunImpl(), XrdCl::TruncateImpl< HasHndl >::RunImpl(), XrdCl::VectorReadImpl< HasHndl >::RunImpl(), XrdCl::VectorWriteImpl< HasHndl >::RunImpl(), XrdCl::WriteVImpl< HasHndl >::RunImpl(), XrdCl::FcntlImpl< HasHndl >::RunImpl(), XrdCl::VisaImpl< HasHndl >::RunImpl(), XrdCl::SetXAttrImpl< HasHndl >::RunImpl(), XrdCl::SetXAttrBulkImpl< HasHndl >::RunImpl(), XrdCl::GetXAttrImpl< HasHndl >::RunImpl(), XrdCl::GetXAttrBulkImpl< HasHndl >::RunImpl(), XrdCl::DelXAttrImpl< HasHndl >::RunImpl(), XrdCl::DelXAttrBulkImpl< HasHndl >::RunImpl(), XrdCl::ListXAttrImpl< HasHndl >::RunImpl(), XrdCl::DeepLocateImpl< HasHndl >::RunImpl(), XrdCl::MvImpl< HasHndl >::RunImpl(), XrdCl::QueryImpl< HasHndl >::RunImpl(), XrdCl::TruncateFsImpl< HasHndl >::RunImpl(), XrdCl::RmImpl< HasHndl >::RunImpl(), XrdCl::MkDirImpl< HasHndl >::RunImpl(), XrdCl::RmDirImpl< HasHndl >::RunImpl(), XrdCl::ChModImpl< HasHndl >::RunImpl(), XrdCl::StatFsImpl< HasHndl >::RunImpl(), XrdCl::StatVFSImpl< HasHndl >::RunImpl(), XrdCl::DirListImpl< HasHndl >::RunImpl(), XrdCl::SendInfoImpl< HasHndl >::RunImpl(), XrdCl::PrepareImpl< HasHndl >::RunImpl(), XrdCl::SetXAttrFsImpl< HasHndl >::RunImpl(), XrdCl::SetXAttrFsBulkImpl< HasHndl >::RunImpl(), XrdCl::GetXAttrFsImpl< HasHndl >::RunImpl(), XrdCl::GetXAttrFsBulkImpl< HasHndl >::RunImpl(), XrdCl::DelXAttrFsImpl< HasHndl >::RunImpl(), XrdCl::DelXAttrFsBulkImpl< HasHndl >::RunImpl(), XrdCl::ListXAttrFsImpl< HasHndl >::RunImpl(), XrdCl::OpenFileImpl< HasHndl >::RunImpl(), XrdCl::ZipReadImpl< HasHndl >::RunImpl(), XrdCl::ZipReadFromImpl< HasHndl >::RunImpl(), XrdCl::ZipWriteImpl< HasHndl >::RunImpl(), XrdCl::AppendFileImpl< HasHndl >::RunImpl(), XrdCl::CloseFileImpl< HasHndl >::RunImpl(), XrdCl::ZipStatImpl< HasHndl >::RunImpl(), XrdCl::ZipListImpl< HasHndl >::RunImpl(), XrdEc::OpenOnlyImpl< HasHndl >::RunImpl(), XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::StreamImpl(), XrdCl::ConcreteOperation< Derived, HasHndl, HdlrFactory, Args >::ToHandled(), and XrdCl::ZipArchive::Write().

◆ valid

template<bool HasHndl>
bool XrdCl::Operation< HasHndl >::valid
protected

Flag indicating if it is a valid object.

Definition at line 314 of file XrdClOperations.hh.


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