XrdOfsFSctl_PI Class Reference

#include <XrdOfsFSctl_PI.hh>

Collaboration diagram for XrdOfsFSctl_PI:
Collaboration graph
[legend]

List of all members.

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_PIprvPI
XrdSysErroreDest

Friends

class XrdOfsConfigPI

Constructor & Destructor Documentation

XrdOfsFSctl_PI::XrdOfsFSctl_PI (  )  [inline]

Constructor.

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

Destructor.


Member Function Documentation

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

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

Friends And Related Function Documentation

friend class XrdOfsConfigPI [friend]

Member Data Documentation


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

Generated on 7 Jul 2020 for xrootd by  doxygen 1.6.1