xrootd
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Macros | Typedefs
XrdOfsPrepare.hh File Reference
#include <string>
#include <vector>
Include dependency graph for XrdOfsPrepare.hh:

Go to the source code of this file.

Classes

class  XrdOfsPrepare
 

Macros

#define XrdOfsgetPrepareArguments
 
#define XrdOfsAddPrepareArguments
 

Typedefs

typedef XrdOfsPrepare *(* XrdOfsgetPrepare_t )(XrdSysError *eDest, const char *confg, const char *parms, XrdSfsFileSystem *theSfs, XrdOss *theOss, XrdOucEnv *envP)
 
typedef XrdOfsPrepare *(* XrdOfsAddPrepare_t )(XrdSysError *eDest, const char *confg, const char *parms, XrdSfsFileSystem *theSfs, XrdOss *theOss, XrdOucEnv *envP, XrdOfsPrepare *prepP)
 

Macro Definition Documentation

#define XrdOfsAddPrepareArguments
Value:
XrdSysError *eDest,\
const char *confg,\
const char *parms,\
XrdSfsFileSystem\
*theSfs,\
XrdOss *theOss,\
XrdOucEnv *envP,\
XrdOfsPrepare *prepP
Definition: XrdSysError.hh:89
#define XrdOfsgetPrepareArguments
Value:
XrdSysError *eDest,\
const char *confg,\
const char *parms,\
XrdSfsFileSystem\
*theSfs,\
XrdOss *theOss,\
XrdOucEnv *envP
Definition: XrdSysError.hh:89

Typedef Documentation

typedef XrdOfsPrepare*(* XrdOfsAddPrepare_t)(XrdSysError *eDest, const char *confg, const char *parms, XrdSfsFileSystem *theSfs, XrdOss *theOss, XrdOucEnv *envP, XrdOfsPrepare *prepP)

Obtain an instance of the XrdOfsPrepare wrapper object.

This extern "C" function is called when a shared library plug-in containing implementation of this class is loaded. It must exist in the shared library and must be thread-safe.

Parameters
eDest-> The error object that must be used to print any errors or other messages (see XrdSysError.hh).
confg-> Name of the configuration file that was used. This pointer may be null though that would be impossible.
parms-> Argument string specified on the namelib directive. It may be null or point to a null string if no parms exist.
theSfs->Pointer to the XrdSfsFileSystem plugin.
theOSs->Pointer to the OSS plugin.
envP-> Pointer to environmental information (may be nil).
prepP-> Pointer to the existing XrdOfsPrepare object that should be wrapped by the returned object.
Returns
Success: A pointer to an instance of the XrdOfsPrepare object. Failure: A null pointer which causes initialization to fail.
typedef XrdOfsPrepare*(* XrdOfsgetPrepare_t)(XrdSysError *eDest, const char *confg, const char *parms, XrdSfsFileSystem *theSfs, XrdOss *theOss, XrdOucEnv *envP)