XRootD
XrdOfsPrepare Class Referenceabstract

#include <XrdOfsPrepare.hh>

+ Inheritance diagram for XrdOfsPrepare:
+ Collaboration diagram for XrdOfsPrepare:

Public Member Functions

 XrdOfsPrepare ()
 Constructor. More...
 
virtual ~XrdOfsPrepare ()
 Destructor. More...
 
virtual int begin (XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
 
virtual int cancel (XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
 
virtual int query (XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
 

Detailed Description

Definition at line 46 of file XrdOfsPrepare.hh.

Constructor & Destructor Documentation

◆ XrdOfsPrepare()

XrdOfsPrepare::XrdOfsPrepare ( )
inline

Constructor.

Definition at line 107 of file XrdOfsPrepare.hh.

107 {}

◆ ~XrdOfsPrepare()

virtual XrdOfsPrepare::~XrdOfsPrepare ( )
inlinevirtual

Destructor.

Definition at line 113 of file XrdOfsPrepare.hh.

113 {}

Member Function Documentation

◆ begin()

virtual int XrdOfsPrepare::begin ( XrdSfsPrep pargs,
XrdOucErrInfo eInfo,
const XrdSecEntity client = 0 
)
pure virtual

Execute a prepare request.

Parameters
pargs- The prepare arguments (see XrdSfsInterface.hh).
eInfo- The object where error or data response is to be returned.
client- Client's identify (may be null).
Returns
One of SFS_OK, SFS_DATA, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED.
Note
Special action taken with certain return codes:
  • SFS_DATA The data is sent to the client as the "requestID".
  • SFS_OK The data pointed to by pargs.reqid is sent to the client as the "requestID".

Implemented in XrdOfsPrepGPIReal::PrepGPI.

Referenced by XrdOfs::prepare().

+ Here is the caller graph for this function:

◆ cancel()

virtual int XrdOfsPrepare::cancel ( XrdSfsPrep pargs,
XrdOucErrInfo eInfo,
const XrdSecEntity client = 0 
)
pure virtual

Cancel a preveious prepare request.

Parameters
pargs- The prepare arguments (see XrdSfsInterface.hh). The pargs.reqid points to the "requestID" associated with the previously issued prepare request.
eInfo- The object where error or data response is to be returned.
client- Client's identify (may be null).
Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED.

Implemented in XrdOfsPrepGPIReal::PrepGPI.

Referenced by XrdOfs::prepare().

+ Here is the caller graph for this function:

◆ query()

virtual int XrdOfsPrepare::query ( XrdSfsPrep pargs,
XrdOucErrInfo eInfo,
const XrdSecEntity client = 0 
)
pure virtual

Query a preveious prepare request.

Parameters
pargs- The prepare arguments (see XrdSfsInterface.hh). The pargs.reqid points to the "requestID" associated with the previously issued prepare request.
eInfo- The object where error or data response is to be returned.
client- Client's identify (may be null).
Returns
One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implemented in XrdOfsPrepGPIReal::PrepGPI.

Referenced by XrdOfs::prepare().

+ Here is the caller graph for this function:

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