26#ifndef __XRD_CL_OPERATIONS_HH__
27#define __XRD_CL_OPERATIONS_HH__
49 template<
bool HasHndl>
class Operation;
117 std::promise<XRootDStatus>
prms,
165 std::promise<XRootDStatus>
prms;
181 template<
bool HasHndl>
188 friend std::future<XRootDStatus>
Async(
Pipeline, uint16_t );
209 if( !op.valid )
throw std::invalid_argument(
"Cannot construct "
210 "Operation from an invalid Operation!" );
250 std::promise<XRootDStatus> prms,
253 static_assert(HasHndl,
"Only an operation that has a handler can be assigned to workflow");
254 handler->Assign( timeout, std::move( prms ), std::move(
final ), this );
270 catch(
const std::exception& ex )
322 friend std::future<XRootDStatus>
Async(
Pipeline, uint16_t );
407 operation->AddOperation( op.ToHandled() );
418 if( !
bool(
operation ) )
throw std::logic_error(
"Invalid pipeline." );
481 throw std::logic_error(
"Pipeline is already running!" );
484 std::promise<XRootDStatus> prms;
485 ftr = prms.get_future();
487 if( !
operation ) std::logic_error(
"Empty pipeline!" );
490 opr->
Run( timeout, std::move( prms ), std::move(
final ) );
501 std::future<XRootDStatus>
ftr;
513 inline std::future<XRootDStatus>
Async(
Pipeline pipeline, uint16_t timeout = 0 )
515 pipeline.
Run( timeout );
516 return std::move( pipeline.
ftr );
530 return Async( std::move( pipeline ), timeout ).get();
541 template<
template<
bool>
class Derived,
bool HasHndl,
typename HdlrFactory,
typename ... Args>
544 template<
template<
bool>
class, bool,
typename,
typename ...>
557 static_assert( !HasHndl,
"It is only possible to construct operation without handler" );
582 template<
typename Hdlr>
585 return this->
StreamImpl( HdlrFactory::Create( hdlr ) );
642 this->
handler->Assign( fo.final );
643 return this->
template Transform<true>();
653 Derived<HasHndl> *me =
static_cast<Derived<HasHndl>*
>( this );
654 return new Derived<HasHndl>( std::move( *me ) );
665 Derived<HasHndl> *me =
static_cast<Derived<HasHndl>*
>( this );
666 return new Derived<true>( std::move( *me ) );
675 Derived<HasHndl> *me =
static_cast<Derived<HasHndl>*
>( this );
676 return std::move( *me );
689 Derived<HasHndl> *me =
static_cast<Derived<HasHndl>*
>( this );
690 return Derived<to>( std::move( *me ) );
702 static_assert( !HasHndl,
"Operator >> is available only for operation without handler" );
704 return Transform<true>();
738 me.AddOperation( op.
Move() );
739 return me.template Transform<true>();
756 return me.template Transform<true>();
Definition: XrdClAnyObject.hh:33
Definition: XrdClOperations.hh:543
Derived< to > Transform()
Definition: XrdClOperations.hh:687
Derived< true > operator|(Operation< true > &&op)
Definition: XrdClOperations.hh:607
static void AllocHandler(ConcreteOperation< Derived, true, HdlrFactory, Args... > &me)
Definition: XrdClOperations.hh:711
static void AllocHandler(ConcreteOperation< Derived, false, HdlrFactory, Args... > &me)
Definition: XrdClOperations.hh:720
std::tuple< Args... > args
Operation arguments.
Definition: XrdClOperations.hh:762
Derived< true > StreamImpl(ResponseHandler *handler)
Definition: XrdClOperations.hh:700
ConcreteOperation(ConcreteOperation< Derived, from, HdlrFactory, Args... > &&op)
Definition: XrdClOperations.hh:568
Derived< HasHndl > Timeout(uint16_t timeout)
Set operation timeout.
Definition: XrdClOperations.hh:672
Derived< true > operator>>(Hdlr &&hdlr)
Definition: XrdClOperations.hh:583
uint16_t timeout
Operation timeout.
Definition: XrdClOperations.hh:767
ConcreteOperation(Args &&... args)
Definition: XrdClOperations.hh:554
Derived< true > operator|(Operation< false > &op)
Definition: XrdClOperations.hh:619
Operation< HasHndl > * Move()
Definition: XrdClOperations.hh:651
static Derived< true > PipeImpl(ConcreteOperation< Derived, HasHndl, HdlrFactory, Args... > &me, Operation< false > &op)
Definition: XrdClOperations.hh:751
Derived< true > operator|(Operation< false > &&op)
Definition: XrdClOperations.hh:631
Derived< true > operator|(FinalOperation &&fo)
Adds a final operation to the pipeline.
Definition: XrdClOperations.hh:639
Operation< true > * ToHandled()
Definition: XrdClOperations.hh:662
static Derived< true > PipeImpl(ConcreteOperation< Derived, HasHndl, HdlrFactory, Args... > &me, Operation< true > &op)
Definition: XrdClOperations.hh:734
friend class ConcreteOperation
Definition: XrdClOperations.hh:545
Derived< true > operator|(Operation< true > &op)
Definition: XrdClOperations.hh:595
static PostMaster * GetPostMaster()
Get default post master.
Definition: XrdClFinalOperation.hh:40
void QueueJob(Job *job, void *arg=0)
Add a job to be run.
Definition: XrdClJobManager.hh:92
Definition: XrdClOperations.hh:183
virtual ~Operation()
Destructor.
Definition: XrdClOperations.hh:217
virtual Operation< HasHndl > * Move()=0
friend class PipelineHandler
Definition: XrdClOperations.hh:191
Operation()
Constructor.
Definition: XrdClOperations.hh:198
void AddOperation(Operation< true > *op)
Definition: XrdClOperations.hh:295
void Run(Timeout timeout, std::promise< XRootDStatus > prms, std::function< void(const XRootDStatus &)> final)
Definition: XrdClOperations.hh:249
bool valid
Flag indicating if it is a valid object.
Definition: XrdClOperations.hh:309
virtual std::string ToString()=0
Name of the operation.
virtual XRootDStatus RunImpl(PipelineHandler *handler, uint16_t timeout)=0
virtual Operation< true > * ToHandled()=0
std::unique_ptr< PipelineHandler > handler
Operation handler.
Definition: XrdClOperations.hh:304
friend std::future< XRootDStatus > Async(Pipeline, uint16_t)
Definition: XrdClOperations.hh:513
Operation(Operation< from > &&op)
Move constructor between template instances.
Definition: XrdClOperations.hh:206
Definition: XrdClParallelOperation.hh:80
Pipeline exception, wrapps an XRootDStatus.
Definition: XrdClOperationHandlers.hh:393
Definition: XrdClOperations.hh:64
void dealloc(XRootDStatus *status, AnyObject *response, HostList *hostList)
Definition: XrdClOperations.hh:134
void HandleResponseWithHosts(XRootDStatus *status, AnyObject *response, HostList *hostList)
Callback function.
PipelineHandler()
Default Constructor.
Definition: XrdClOperations.hh:79
Timeout timeout
Pipeline timeout.
Definition: XrdClOperations.hh:160
void Assign(const Timeout &timeout, std::promise< XRootDStatus > prms, std::function< void(const XRootDStatus &)> final, Operation< true > *opr)
std::unique_ptr< ResponseHandler > responseHandler
The handler of our operation.
Definition: XrdClOperations.hh:145
~PipelineHandler()
Destructor.
Definition: XrdClOperations.hh:97
std::promise< XRootDStatus > prms
The promise that there will be a result (traveling along the pipeline)
Definition: XrdClOperations.hh:165
PipelineHandler(ResponseHandler *handler)
void HandleResponseImpl(XRootDStatus *status, AnyObject *response, HostList *hostList=nullptr)
Callback function implementation;.
std::unique_ptr< Operation< true > > currentOperation
The operation the handler is assigned to.
Definition: XrdClOperations.hh:150
void HandleResponse(XRootDStatus *status, AnyObject *response)
Callback function.
void AddOperation(Operation< true > *operation)
void Assign(std::function< void(const XRootDStatus &)> final)
Assign the finalization routine.
std::unique_ptr< Operation< true > > nextOperation
Next operation in the pipeline.
Definition: XrdClOperations.hh:155
Definition: XrdClOperations.hh:320
Pipeline(Operation< true > *op)
Constructor.
Definition: XrdClOperations.hh:337
std::future< XRootDStatus > ftr
The future result of the pipeline.
Definition: XrdClOperations.hh:501
Pipeline(Operation< true > &&op)
Constructor.
Definition: XrdClOperations.hh:353
Pipeline & operator|=(Operation< true > &&op)
Extend pipeline.
Definition: XrdClOperations.hh:396
static void Repeat()
Repeat current operation.
Operation< true > * operator->()
Definition: XrdClOperations.hh:467
static void Stop(const XRootDStatus &status=XrdCl::XRootDStatus())
Pipeline(Operation< true > &op)
Constructor.
Definition: XrdClOperations.hh:345
Pipeline(Pipeline &&pipe)
Definition: XrdClOperations.hh:379
Pipeline & operator=(Pipeline &&pipe)
Constructor.
Definition: XrdClOperations.hh:387
Pipeline(Operation< false > *op)
Definition: XrdClOperations.hh:358
static void Replace(Operation< false > &&opr)
Replace current operation.
Pipeline(Operation< false > &&op)
Constructor.
Definition: XrdClOperations.hh:374
friend std::future< XRootDStatus > Async(Pipeline, uint16_t)
Definition: XrdClOperations.hh:513
std::unique_ptr< Operation< true > > operation
First operation in the pipeline.
Definition: XrdClOperations.hh:496
void Run(Timeout timeout, std::function< void(const XRootDStatus &)> final=nullptr)
Definition: XrdClOperations.hh:478
static void Ignore()
Ignore error and proceed with the pipeline.
Pipeline(Operation< false > &op)
Constructor.
Definition: XrdClOperations.hh:366
Pipeline()
Default constructor.
Definition: XrdClOperations.hh:330
static void Replace(Pipeline p)
Replace with pipeline.
Pipeline & operator|=(Operation< false > &&op)
Extend pipeline.
Definition: XrdClOperations.hh:405
JobManager * GetJobManager()
Get the job manager object user by the post master.
Handle an async response.
Definition: XrdClXRootDResponses.hh:1126
Call the user callback.
Definition: XrdClResponseJob.hh:31
Definition: XrdClOperationTimeout.hh:20
Request status.
Definition: XrdClXRootDResponses.hh:219
Definition: XrdClOperationTimeout.hh:17
Definition: XrdClAction.hh:34
const uint16_t errOperationExpired
Definition: XrdClStatus.hh:90
const uint16_t stError
An error occurred that could potentially be retried.
Definition: XrdClStatus.hh:32
std::function< Operation< true > *(const XRootDStatus &)> rcvry_func
Type of the recovery function to be provided by the user.
Definition: XrdClOperations.hh:57
XRootDStatus WaitFor(Pipeline pipeline, uint16_t timeout=0)
Definition: XrdClOperations.hh:528
std::vector< HostInfo > HostList
Definition: XrdClXRootDResponses.hh:1120
const uint16_t errInternal
Internal error.
Definition: XrdClStatus.hh:56
std::future< XRootDStatus > Async(Pipeline pipeline, uint16_t timeout=0)
Definition: XrdClOperations.hh:513
ssize_t Move(KernelBuffer &kbuff, char *&ubuff)
Definition: XrdSysKernelBuffer.hh:452
Definition: XrdOucJson.hh:4517
bool IsOK() const
We're fine.
Definition: XrdClStatus.hh:124