Open operation (. More...

#include <XrdClFileOperations.hh>

Inheritance diagram for XrdCl::OpenImpl< HasHndl >:

Collaboration diagram for XrdCl::OpenImpl< HasHndl >:

Public Types
enum	{ UrlArg , FlagsArg , ModeArg }
	Argument indexes in the args tuple. More...

Public Member Functions
	OpenImpl (Ctx< File > f, Arg< std::string > url, Arg< OpenFlags::Flags > flags, Arg< Access::Mode > mode=Access::None)
	Constructor (.
template<bool from>
	OpenImpl (OpenImpl< from > &&open)
template<typename Hdlr>
OpenImpl< true >	operator>> (Hdlr &&hdlr)
std::string	ToString ()
Public Member Functions inherited from XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >
virtual	~FileOperation ()
	Destructor.
Public Member Functions inherited from XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >
Operation< HasHndl > *	Move ()
OpenImpl< true >	operator>> (Hdlr &&hdlr)
OpenImpl< true >	operator\| (Operation< true > &op)
OpenImpl< HasHndl >	Timeout (time_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.

Protected Member Functions
XRootDStatus	RunImpl (PipelineHandler *handler, time_t pipelineTimeout)
Protected Member Functions inherited from XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >
OpenImpl< true >	StreamImpl (ResponseHandler *handler)
OpenImpl< 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< OpenImpl, HasHndl, Resp< void >, Arguments... >
static void	AllocHandler (ConcreteOperation< OpenImpl, true, Resp< void >, Args... > &me)
static OpenImpl< true >	PipeImpl (ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Args... > &me, Operation< true > &op)
Protected Attributes inherited from XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >
Ctx< File >	file
	The file object itself.
Protected Attributes inherited from XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >
std::tuple< Args... >	args
	Operation arguments.
time_t	timeout
	Operation timeout.
Protected Attributes inherited from XrdCl::Operation< HasHndl >
std::unique_ptr< PipelineHandler >	handler
	Operation handler.
bool	valid
	Flag indicating if it is a valid object.

Detailed Description

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

Open operation (.

See also: FileOperation)

Definition at line 95 of file XrdClFileOperations.hh.

Member Enumeration Documentation

◆ anonymous enum

template<bool HasHndl>

anonymous enum

Argument indexes in the args tuple.

Enumerator
UrlArg
FlagsArg
ModeArg

Definition at line 170 of file XrdClFileOperations.hh.

170{ UrlArg, FlagsArg, ModeArg };

XrdCl::OpenImpl::FlagsArg

@ FlagsArg

Definition XrdClFileOperations.hh:170

XrdCl::OpenImpl::ModeArg

@ ModeArg

Definition XrdClFileOperations.hh:170

XrdCl::OpenImpl::UrlArg

@ UrlArg

Definition XrdClFileOperations.hh:170

Constructor & Destructor Documentation

◆ OpenImpl() [1/2]

template<bool HasHndl>

XrdCl::OpenImpl< HasHndl >::OpenImpl	(	Ctx< File >	f,
		Arg< std::string >	url,
		Arg< OpenFlags::Flags >	flags,
		Arg< Access::Mode >	mode = Access::None )

inline

Constructor (.

See also: FileOperation)

Definition at line 144 of file XrdClFileOperations.hh.

                                                    :
          FileOperation<OpenImpl, HasHndl, Resp<void>, Arg<std::string>, Arg<OpenFlags::Flags>,
            Arg<Access::Mode>>( std::move( f ), std::move( url ), std::move( flags ),
            std::move( mode ) )
      {
      }

References XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >::FileOperation, OpenImpl(), Mode, and XrdCl::Access::None.

Referenced by OpenImpl(), OpenImpl(), and operator>>().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OpenImpl() [2/2]

template<bool HasHndl>

template<bool from>

XrdCl::OpenImpl< HasHndl >::OpenImpl ( OpenImpl< from > && open )

inline

Move constructor from other states

from : state from which the object is being converted

Parameters

open	: the object that is being converted

Definition at line 160 of file XrdClFileOperations.hh.

                                         :
          FileOperation<OpenImpl, HasHndl, Resp<void>, Arg<std::string>, Arg<OpenFlags::Flags>,
            Arg<Access::Mode>>( std::move( open ) )
      {
      }

References XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >::FileOperation, OpenImpl(), Mode, and open.

Here is the call graph for this function:

Member Function Documentation

◆ operator>>()

template<bool HasHndl>

template<typename Hdlr>

OpenImpl< true > XrdCl::OpenImpl< HasHndl >::operator>> ( Hdlr && hdlr )

inline

Overload of operator>> defined in ConcreteOperation, we're adding additional capabilities by using ExResp factory (

See also: ExResp).

Parameters

hdlr	: function/functor/lambda

Definition at line 179 of file XrdClFileOperations.hh.

      {
        ExResp factory( *this->file );
        return this->StreamImpl( factory.Create( hdlr ) );
      }

References OpenImpl(), XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >::file, and XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >::StreamImpl().

Here is the call graph for this function:

◆ RunImpl()

template<bool HasHndl>

XRootDStatus XrdCl::OpenImpl< HasHndl >::RunImpl	(	PipelineHandler *	handler,
		time_t	pipelineTimeout )

inlineprotectedvirtual

RunImpl operation (

See also: Operation)

Parameters

pipelineTimeout : pipeline timeout

Returns: : status of the operation

Implements XrdCl::Operation< HasHndl >.

Definition at line 201 of file XrdClFileOperations.hh.

      {
        const std::string &url     = std::get<UrlArg>( this->args );
        OpenFlags::Flags   flags   = std::get<FlagsArg>( this->args );
        Access::Mode       mode    = std::get<ModeArg>( this->args );
        time_t             timeout = pipelineTimeout < this->timeout ?
                                     pipelineTimeout : this->timeout;
        return this->file->Open( url, flags, mode, handler, timeout );
      }

References XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >::args, XrdCl::FileOperation< OpenImpl, HasHndl, Resp< void >, Arg< std::string >, Arg< OpenFlags::Flags >, Arg< Access::Mode > >::file, XrdCl::Operation< HasHndl >::handler, and XrdCl::ConcreteOperation< OpenImpl, HasHndl, Resp< void >, Arguments... >::timeout.

◆ ToString()

template<bool HasHndl>

std::string XrdCl::OpenImpl< HasHndl >::ToString ( )

inlinevirtual

Returns: : name of the operation (

See also: Operation)

Implements XrdCl::Operation< HasHndl >.

Definition at line 188 of file XrdClFileOperations.hh.

      {
        return "Open";
      }

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

XrdClFileOperations.hh

	XRootD

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ OpenImpl() [1/2]

◆ OpenImpl() [2/2]

Member Function Documentation

◆ operator>>()

◆ RunImpl()

◆ ToString()