XrdPfcFSctl Class Reference

#include <XrdPfcFSctl.hh>

Inheritance diagram for XrdPfcFSctl:

Collaboration diagram for XrdPfcFSctl:

Public Member Functions
virtual bool	Configure (const char *CfgFN, const char *Parms, XrdOucEnv *envP, const Plugins &plugs) override
virtual int	FSctl (const int cmd, int alen, const char *args, XrdSfsFile &file, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0) override
virtual int	FSctl (const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0) override
	XrdPfcFSctl (XrdPfc::Cache &cInst, XrdSysLogger *logP)
	Constructor.
virtual	~XrdPfcFSctl ()
	Destructor.
Public Member Functions inherited from XrdOfsFSctl_PI
	XrdOfsFSctl_PI ()
	Constructor.
virtual	~XrdOfsFSctl_PI ()
	Destructor.

Private Member Functions
XrdSysTrace *	GetTrace ()

Private Attributes
XrdPfc::Cache &	myCache
XrdOfsHandle *	hProc
XrdSysError	Log
XrdSysTrace *	sysTrace
const char *	m_traceID

Additional Inherited Members
Protected Attributes inherited from XrdOfsFSctl_PI
XrdOfsFSctl_PI *	prvPI
XrdSysError *	eDest

Constructor & Destructor Documentation

XrdPfcFSctl()

XrdPfcFSctl::XrdPfcFSctl	(	XrdPfc::Cache &	cInst,
		XrdSysLogger *	logP
	)

Constructor.

~XrdPfcFSctl()

virtual XrdPfcFSctl::~XrdPfcFSctl ( )

inlinevirtual

Destructor.

Member Function Documentation

Configure()

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

overridevirtual

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 from XrdOfsFSctl_PI.

FSctl() [1/2]

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

overridevirtual

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.

Implements XrdOfsFSctl_PI.

FSctl() [2/2]

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

overridevirtual

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.

Implements XrdOfsFSctl_PI.

GetTrace()

XrdSysTrace * XrdPfcFSctl::GetTrace ( )

inlineprivate

References sysTrace.

Member Data Documentation

hProc

XrdOfsHandle* XrdPfcFSctl::hProc

private

Log

XrdSysError XrdPfcFSctl::Log

private

m_traceID

const char* XrdPfcFSctl::m_traceID

private

myCache

XrdPfc::Cache& XrdPfcFSctl::myCache

private

sysTrace

XrdSysTrace* XrdPfcFSctl::sysTrace

private

Referenced by GetTrace().

---

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

• XrdPfcFSctl.hh