#include <XrdClOperations.hh>

Collaboration diagram for XrdCl::Pipeline:

Public Member Functions
	Pipeline ()
	Default constructor.
	Pipeline (Operation< false > &&op)
	Constructor.
	Pipeline (Operation< false > &op)
	Constructor.
	Pipeline (Operation< false > *op)
	Pipeline (Operation< true > &&op)
	Constructor.
	Pipeline (Operation< true > &op)
	Constructor.
	Pipeline (Operation< true > *op)
	Constructor.
	Pipeline (Pipeline &&pipe)
	operator bool ()
	operator Operation< true > & ()
Pipeline &	operator= (Pipeline &&pipe)
	Constructor.
Pipeline &	operator\|= (Operation< false > &&op)
	Extend pipeline.
Pipeline &	operator\|= (Operation< true > &&op)
	Extend pipeline.

Static Public Member Functions
static void	Ignore ()
	Ignore error and proceed with the pipeline.
static void	Repeat ()
	Repeat current operation.
static void	Replace (Operation< false > &&opr)
	Replace current operation.
static void	Replace (Pipeline p)
	Replace with pipeline.
static void	Stop (const XRootDStatus &status=XrdCl::XRootDStatus())

Friends
std::future< XRootDStatus >	Async (Pipeline pipeline, time_t timeout=0)
template<bool>
class	ParallelOperation
class	PipelineHandler

Detailed Description

A wrapper around operation pipeline. A Pipeline is a once-use-only object - once executed by a Workflow engine it is invalidated.

Takes ownership of given operation pipeline (which is in most would be a temporary object)

Definition at line 289 of file XrdClOperations.hh.

Constructor & Destructor Documentation

◆ Pipeline() [1/8]

XrdCl::Pipeline::Pipeline ( )

inline

Default constructor.

Definition at line 300 of file XrdClOperations.hh.

301 {

302 }

Referenced by Pipeline(), operator=(), operator|=(), operator|=(), ParallelOperation, and Replace().

Here is the caller graph for this function:

◆ Pipeline() [2/8]

XrdCl::Pipeline::Pipeline ( Operation< true > * op )

inline

Constructor.

Definition at line 307 of file XrdClOperations.hh.

                                      :
          operation( op->Move() )
      {
      }

◆ Pipeline() [3/8]

XrdCl::Pipeline::Pipeline ( Operation< true > & op )

inline

Constructor.

Definition at line 315 of file XrdClOperations.hh.

                                      :
          operation( op.Move() )
      {
      }

◆ Pipeline() [4/8]

XrdCl::Pipeline::Pipeline ( Operation< true > && op )

inline

Constructor.

Definition at line 323 of file XrdClOperations.hh.

                                       :
          operation( op.Move() )
      {
      }

◆ Pipeline() [5/8]

XrdCl::Pipeline::Pipeline ( Operation< false > * op )

inline

Definition at line 328 of file XrdClOperations.hh.

                                       :
          operation( op->ToHandled() )
      {
      }

◆ Pipeline() [6/8]

XrdCl::Pipeline::Pipeline ( Operation< false > & op )

inline

Constructor.

Definition at line 336 of file XrdClOperations.hh.

                                       :
          operation( op.ToHandled() )
      {
      }

◆ Pipeline() [7/8]

XrdCl::Pipeline::Pipeline ( Operation< false > && op )

inline

Constructor.

Definition at line 344 of file XrdClOperations.hh.

                                        :
          operation( op.ToHandled() )
      {
      }

◆ Pipeline() [8/8]

XrdCl::Pipeline::Pipeline ( Pipeline && pipe )

inline

Definition at line 349 of file XrdClOperations.hh.

                                  :
          operation( std::move( pipe.operation ) )
      {
      }

References Pipeline().

Here is the call graph for this function:

Member Function Documentation

◆ Ignore()

void XrdCl::Pipeline::Ignore ( )

static

Ignore error and proceed with the pipeline.

Definition at line 275 of file XrdClOperations.cc.

  {
    throw IgnoreError();
  }

◆ operator bool()

XrdCl::Pipeline::operator bool ( )

inline

Conversion to boolean

Returns: : true if it's a valid pipeline, false otherwise

Definition at line 397 of file XrdClOperations.hh.

      {
        return bool( operation );
      }

◆ operator Operation< true > &()

XrdCl::Pipeline::operator Operation< true > & ( )

inline

Conversion to Operation<true>

Exceptions

std::logic_error if pipeline is invalid

Definition at line 386 of file XrdClOperations.hh.

      {
        if( !bool( operation ) ) throw std::logic_error( "Invalid pipeline." );
        return *operation.get();
      }

◆ operator=()

Pipeline & XrdCl::Pipeline::operator= ( Pipeline && pipe )

inline

Constructor.

Definition at line 357 of file XrdClOperations.hh.

      {
        operation = std::move( pipe.operation );
        return *this;
      }

References Pipeline().

Here is the call graph for this function:

◆ operator|=() [1/2]

Pipeline & XrdCl::Pipeline::operator|= ( Operation< false > && op )

inline

Extend pipeline.

Definition at line 375 of file XrdClOperations.hh.

      {
        operation->AddOperation( op.ToHandled() );
        return *this;
      }

References Pipeline(), and XrdCl::Operation< HasHndl >::AddOperation().

Here is the call graph for this function:

◆ operator|=() [2/2]

Pipeline & XrdCl::Pipeline::operator|= ( Operation< true > && op )

inline

Extend pipeline.

Definition at line 366 of file XrdClOperations.hh.

      {
        operation->AddOperation( op.Move() );
        return *this;
      }

References Pipeline(), and XrdCl::Operation< HasHndl >::AddOperation().

Here is the call graph for this function:

◆ Repeat()

void XrdCl::Pipeline::Repeat ( )

static

Repeat current operation.

Definition at line 251 of file XrdClOperations.cc.

  {
    throw RepeatOpeation();
  }

Referenced by XrdCl::ZipArchive::OpenArchive().

Here is the caller graph for this function:

◆ Replace() [1/2]

void XrdCl::Pipeline::Replace ( Operation< false > && opr )

static

Replace current operation.

Definition at line 259 of file XrdClOperations.cc.

  {
    throw ReplaceOperation( std::move( opr ) );
  }

◆ Replace() [2/2]

void XrdCl::Pipeline::Replace ( Pipeline p )

static

Replace with pipeline.

Definition at line 267 of file XrdClOperations.cc.

  {
    throw ReplacePipeline( std::move( p ) );
  }

References Pipeline().

Here is the call graph for this function:

◆ Stop()

void XrdCl::Pipeline::Stop ( const XRootDStatus & status = XrdCl::XRootDStatus() )

static

Stop the current pipeline

Parameters

status : the final status for the pipeline

Definition at line 243 of file XrdClOperations.cc.

  {
    throw StopPipeline( status );
  }

Referenced by XrdCl::ZipArchive::OpenArchive().

Here is the caller graph for this function:

◆ Async

std::future< XRootDStatus > Async	(	Pipeline	pipeline,
		time_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 487 of file XrdClOperations.hh.

  {
    pipeline.Run( timeout );
    return std::move( pipeline.ftr );
  }

◆ ParallelOperation

template<bool>

friend class ParallelOperation

friend

Definition at line 291 of file XrdClOperations.hh.

References Pipeline(), and ParallelOperation.

Referenced by ParallelOperation.

◆ PipelineHandler

friend class PipelineHandler

friend

Definition at line 293 of file XrdClOperations.hh.

References PipelineHandler.

Referenced by PipelineHandler.

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

	XRootD

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Pipeline() [1/8]

◆ Pipeline() [2/8]

◆ Pipeline() [3/8]

◆ Pipeline() [4/8]

◆ Pipeline() [5/8]

◆ Pipeline() [6/8]

◆ Pipeline() [7/8]

◆ Pipeline() [8/8]

Member Function Documentation

◆ Ignore()

◆ operator bool()

◆ operator Operation< true > &()

◆ operator=()

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ Repeat()

◆ Replace() [1/2]

◆ Replace() [2/2]

◆ Stop()

Friends And Related Symbol Documentation

◆ Async

◆ ParallelOperation

◆ PipelineHandler