XrdOfsFSctl_PI Class Reference

#include <XrdOfsFSctl_PI.hh>

Inheritance diagram for XrdOfsFSctl_PI:

Collaboration diagram for XrdOfsFSctl_PI:

Classes
struct	Plugins
	The Plugins struct is used to pass plugin pointers to configure. More...

Public Member Functions
virtual bool	Configure (const char *CfgFN, const char *Parms, XrdOucEnv *envP, const Plugins &plugs)
virtual int	FSctl (const int cmd, int alen, const char *args, XrdSfsFile &file, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
virtual int	FSctl (const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
	XrdOfsFSctl_PI ()
	Constructor.
virtual	~XrdOfsFSctl_PI ()
	Destructor.

Protected Attributes
XrdOfsFSctl_PI *	prvPI
XrdSysError *	eDest

Friends
class	XrdOfsConfigPI

Constructor & Destructor Documentation

XrdOfsFSctl_PI()

XrdOfsFSctl_PI::XrdOfsFSctl_PI ( )

inline

Constructor.

~XrdOfsFSctl_PI()

virtual XrdOfsFSctl_PI::~XrdOfsFSctl_PI ( )

inlinevirtual

Destructor.

Member Function Documentation

Configure()

virtual bool XrdOfsFSctl_PI::Configure ( const char *  CfgFN, const char *  Parms, XrdOucEnv *  envP, const Plugins &  plugs  )

inlinevirtual

Configure plugin.

Parameters

CfgFN	- Path of the configuration file.
Parms	- Any parameters specified on the directive (may be null).
envP	- Pointer to environmental information
plugs	- Reference to the struct containing plugin pointers. Unloaded plugins have a nil pointer.

Returns

True upon success and false otherwise.

Reimplemented in XrdPfcFSctl.

FSctl() [1/2]

virtual int XrdOfsFSctl_PI::FSctl ( const int  cmd, int  alen, const char *  args, XrdSfsFile &  file, XrdOucErrInfo &  eInfo, const XrdSecEntity *  client = 0  )

pure virtual

Perform a file control operation

Parameters

cmd	- The operation to be performed: SFS_FCTL_SPEC1 Return Implementation Dependent Data
alen	- The length of args.
args	- Arguments specific to cmd. SFS_FCTL_SPEC1 Unscreened args string.
file	- Reference to the target file object.
eInfo	- The object where error info or results are to be returned.
client	- Client's identify (see common description).

Returns

SFS_OK a null response is sent. SFS_DATA error.code length of the data to be sent. error.message contains the data to be sent. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implemented in XrdPfcFSctl.

FSctl() [2/2]

virtual int XrdOfsFSctl_PI::FSctl ( const int  cmd, XrdSfsFSctl &  args, XrdOucErrInfo &  eInfo, const XrdSecEntity *  client = 0  )

pure virtual

Perform a filesystem control operation (version 2)

Parameters

cmd	- The operation to be performed: SFS_FSCTL_PLUGIN Return Implementation Dependent Data v1 SFS_FSCTL_PLUGIO Return Implementation Dependent Data v2
args	- Arguments specific to cmd. SFS_FSCTL_PLUGIN path and opaque information, fileP == 0 SFS_FSCTL_PLUGIO Unscreened argument string, fileP == 0
eInfo	- The object where error info or results are to be returned.
client	- Client's identify (see common description).

Returns

SFS_OK a null response is sent. SFS_DATA error.code length of the data to be sent. error.message contains the data to be sent. o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implemented in XrdPfcFSctl.

Friends And Related Symbol Documentation

XrdOfsConfigPI

friend class XrdOfsConfigPI

friend

Member Data Documentation

eDest

XrdSysError* XrdOfsFSctl_PI::eDest

protected

prvPI

XrdOfsFSctl_PI* XrdOfsFSctl_PI::prvPI

protected

---

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

• XrdOfsFSctl_PI.hh