XrdOfsPrepare Class Reference

#include <XrdOfsPrepare.hh>

List of all members.

Public Member Functions

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
 XrdOfsPrepare ()
 Constructor.
virtual ~XrdOfsPrepare ()
 Destructor.

Constructor & Destructor Documentation

XrdOfsPrepare::XrdOfsPrepare (  )  [inline]

Constructor.

virtual XrdOfsPrepare::~XrdOfsPrepare (  )  [inline, virtual]

Destructor.


Member Function Documentation

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".
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.
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.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 23 Mar 2020 for xrootd by  doxygen 1.6.1