#include <XrdSsiSfs.hh>

Inheritance diagram for XrdSsiSfs:

Collaboration diagram for XrdSsiSfs:

Public Member Functions
XrdSfsDirectory *	newDir (char *user=0, int MonID=0)

XrdSfsFile *	newFile (char *user=0, int MonID=0)

int	chksum (csFunc Func, const char csName, const char path, XrdOucErrInfo &eInfo, const XrdSecEntity client=0, const char opaque=0)

int	chmod (const char Name, XrdSfsMode Mode, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *opaque=0)

int	exists (const char fileName, XrdSfsFileExistence &exists_flag, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *opaque=0)

int	fsctl (const int cmd, const char args, XrdOucErrInfo &eInfo, const XrdSecEntity client)

int	getStats (char *buff, int blen)

const char *	getVersion ()

int	mkdir (const char dirName, XrdSfsMode Mode, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *opaque=0)

int	prepare (XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)

int	rem (const char path, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *info=0)

int	remdir (const char dirName, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *info=0)

int	rename (const char oldFileName, const char newFileName, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char infoO=0, const char *infoN=0)

int	stat (const char Name, struct stat buf, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char opaque=0)

int	stat (const char Name, mode_t &mode, XrdOucErrInfo &eInfo, const XrdSecEntity client, const char *opaque=0)

int	truncate (const char Name, XrdSfsFileOffset fileOffset, XrdOucErrInfo &eInfo, const XrdSecEntity client=0, const char *opaque=0)

void	setFeatures (XrdSfsFileSystem *prevFS)

	XrdSsiSfs ()

virtual	~XrdSsiSfs ()

Public Member Functions inherited from XrdSfsFileSystem
virtual XrdSfsDirectory *	newDir (XrdOucErrInfo &eInfo)

virtual XrdSfsFile *	newFile (XrdOucErrInfo &eInfo)

virtual void	Connect (const XrdSecEntity *client=0)

virtual void	Disc (const XrdSecEntity *client=0)

virtual void	EnvInfo (XrdOucEnv *envP)

virtual int	FAttr (XrdSfsFACtl faReq, XrdOucErrInfo &eInfo, const XrdSecEntity client=0)

uint64_t	Features ()

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

virtual int	getChkPSize ()

virtual int	gpFile (gpfFunc &gpAct, XrdSfsGPFile &gpReq, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)

	XrdSfsFileSystem ()
	Constructor and Destructor.

virtual	~XrdSfsFileSystem ()

Static Public Member Functions
static void	setMax (int mVal)

Private Member Functions
int	Emsg (const char pfx, XrdOucErrInfo &einfo, int ecode, const char op, const char *target)

const char *	Split (const char Args, const char Opq, char Path, int Plen)

Static Private Attributes
static int	freeMax

Friends
class	XrdSsiFile

Additional Inherited Members
Public Types inherited from XrdSfsFileSystem
enum	csFunc { csCalc = 0 , csGet , csSize }

enum	gpfFunc { gpfCancel =0 , gpfGet , gpfPut }

Protected Attributes inherited from XrdSfsFileSystem
uint64_t	FeatureSet
	Adjust features at initialization.

Constructor & Destructor Documentation

◆ XrdSsiSfs()

XrdSsiSfs::XrdSsiSfs ( )

inline

◆ ~XrdSsiSfs()

virtual XrdSsiSfs::~XrdSsiSfs ( )

inlinevirtual

Member Function Documentation

◆ chksum()

int XrdSsiSfs::chksum	(	csFunc	Func,
		const char *	csName,
		const char *	path,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client = `0`,
		const char *	opaque = `0`
	)

virtual

Reimplemented from XrdSfsFileSystem.

◆ chmod()

int XrdSsiSfs::chmod	(	const char *	path,
		XrdSfsMode	mode,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Change file mode settings.

Parameters

path	- Pointer to the path of the file in question.
mode	- The new file mode setting.
eInfo	- The object where error info or results are to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT or SFS_STALL

Implements XrdSfsFileSystem.

◆ Emsg()

int XrdSsiSfs::Emsg	(	const char *	pfx,
		XrdOucErrInfo &	einfo,
		int	ecode,
		const char *	op,
		const char *	target
	)

private

◆ exists()

int XrdSsiSfs::exists	(	const char *	path,
		XrdSfsFileExistence &	eFlag,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Return directory/file existence information (short stat).

Parameters

path	- Pointer to the path of the file/directory in question.
eFlag	- Where the results are to be returned.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED When SFS_OK is returned, eFlag must be properly set, as follows: XrdSfsFileExistNo - path does not exist XrdSfsFileExistIsFile - path refers to an online file XrdSfsFileExistIsDirectory - path refers to an online directory XrdSfsFileExistIsOffline - path refers to an offline file XrdSfsFileExistIsOther - path is neither a file nor directory

Implements XrdSfsFileSystem.

◆ fsctl()

int XrdSsiSfs::fsctl	(	const int	cmd,
		const char *	args,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client
	)

virtual

Perform a filesystem control operation (version 1)

Parameters

cmd	- The operation to be performed: SFS_FSCTL_LOCATE Locate a file or file servers SFS_FSCTL_STATCC Return cluster config status SFS_FSCTL_STATFS Return physical filesystem information SFS_FSCTL_STATLS Return logical filesystem information SFS_FSCTL_STATXA Return extended attributes
args	- Arguments specific to cmd. SFS_FSCTL_LOCATE args points to the path to be located "" path is the first exported path "" return all current servers "&zwj;/" return servers exporting path o/w return servers having the path SFS_FSCTL_STATFS Path in the filesystem in question. SFS_FSCTL_STATLS Path in the filesystem in question. SFS_FSCTL_STATXA Path of the file whose xattr is wanted.
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.; SFS_STARTED Operation started result will be returned via callback. Valid only for for SFS_FSCTL_LOCATE, SFS_FSCTL_STATFS, and SFS_FSCTL_STATXA o/w one of SFS_ERROR, SFS_REDIRECT, or SFS_STALL.

Implements XrdSfsFileSystem.

◆ getStats()

int XrdSsiSfs::getStats	(	char *	buff,
		int	blen
	)

virtual

Return statistical information.

Parameters

buff	- Pointer to the buffer where results are to be returned. Statistics should be in standard XML format. If buff is nil then only maximum size information is wanted.
blen	- The length available in buff.

Returns: Number of bytes placed in buff. When buff is nil, the maximum number of bytes that could have been placed in buff.

Implements XrdSfsFileSystem.

◆ getVersion()

const char * XrdSsiSfs::getVersion ( )

virtual

Get version string.

Returns: The version string. Normally this is the XrdVERSION value.

Implements XrdSfsFileSystem.

◆ mkdir()

int XrdSsiSfs::mkdir	(	const char *	path,
		XrdSfsMode	mode,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Create a directory.

Parameters

path	- Pointer to the path of the directory to be created.
mode	- The directory mode setting.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

◆ newDir()

XrdSfsDirectory * XrdSsiSfs::newDir	(	char *	user = `0`,
		int	MonID = `0`
	)

inlinevirtual

Obtain a new director object to be used for future directory requests.

Parameters

user	- Text identifying the client responsible for this call. The pointer may be null if identification is missing.
MonID	- The monitoring identifier assigned to this and all future requests using the returned object.

Returns: pointer- Pointer to an XrdSfsDirectory object.; nil - Insufficient memory to allocate an object.

Implements XrdSfsFileSystem.

◆ newFile()

XrdSfsFile * XrdSsiSfs::newFile	(	char *	user = `0`,
		int	MonID = `0`
	)

inlinevirtual

Obtain a new file object to be used for a future file requests.

Parameters

user	- Text identifying the client responsible for this call. The pointer may be null if identification is missing.
MonID	- The monitoring identifier assigned to this and all future requests using the returned object.

Returns: pointer- Pointer to an XrdSfsFile object.; nil - Insufficient memory to allocate an object.

Implements XrdSfsFileSystem.

References XrdSsiFile.

◆ prepare()

int XrdSsiSfs::prepare	(	XrdSfsPrep &	pargs,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client = `0`
	)

virtual

Prepare a file for future processing.

Parameters

pargs	- The preapre arguments.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

◆ rem()

int XrdSsiSfs::rem	(	const char *	path,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Remove a file.

Parameters

path	- Pointer to the path of the file to be removed.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

◆ remdir()

int XrdSsiSfs::remdir	(	const char *	path,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Remove a directory.

Parameters

path	- Pointer to the path of the directory to be removed.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- Path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

◆ rename()

int XrdSsiSfs::rename	(	const char *	oPath,
		const char *	nPath,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaqueO = `0`,
		const char *	opaqueN = `0`
	)

virtual

Rename a file or directory.

Parameters

oPath	- Pointer to the path to be renamed.
nPath	- Pointer to the path oPath is to have.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaqueO	- oPath's CGI information (see common description).
opaqueN	- nPath's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

◆ setFeatures()

void XrdSsiSfs::setFeatures ( XrdSfsFileSystem * prevFS )

◆ setMax()

static void XrdSsiSfs::setMax ( int mVal )

inlinestatic

References freeMax.

◆ Split()

const char * XrdSsiSfs::Split	(	const char *	Args,
		const char **	Opq,
		char *	Path,
		int	Plen
	)

private

◆ stat() [1/2]

int XrdSsiSfs::stat	(	const char *	path,
		mode_t &	mode,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Return mode information on a file or directory.

Parameters

path	- Pointer to the path in question.
mode	- Where full mode information is to be returned.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED When SFS_OK is returned, mode must contain mode information. If teh mode is -1 then it is taken as an offline file.

Implements XrdSfsFileSystem.

◆ stat() [2/2]

int XrdSsiSfs::stat	(	const char *	Name,
		struct stat *	buf,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client,
		const char *	opaque = `0`
	)

virtual

Return state information on a file or directory.

Parameters

Name	- Pointer to the path in question.
buf	- Pointer to the structure where info it to be returned.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, SFS_STALL, or SFS_STARTED When SFS_OK is returned, buf must contain stat information.

Implements XrdSfsFileSystem.

◆ truncate()

int XrdSsiSfs::truncate	(	const char *	path,
		XrdSfsFileOffset	fsize,
		XrdOucErrInfo &	eInfo,
		const XrdSecEntity *	client = `0`,
		const char *	opaque = `0`
	)

virtual

Truncate a file.

Parameters

path	- Pointer to the path of the file to be truncated.
fsize	- The size that the file is to have.
eInfo	- The object where error info is to be returned.
client	- Client's identify (see common description).
opaque	- path's CGI information (see common description).

Returns: One of SFS_OK, SFS_ERROR, SFS_REDIRECT, or SFS_STALL

Implements XrdSfsFileSystem.

Friends And Related Symbol Documentation

◆ XrdSsiFile

friend class XrdSsiFile

friend

Referenced by newFile().

Member Data Documentation

◆ freeMax

int XrdSsiSfs::freeMax

staticprivate

Referenced by setMax().

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

XrdSsiSfs.hh

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ XrdSsiSfs()

◆ ~XrdSsiSfs()

Member Function Documentation

◆ chksum()

◆ chmod()

◆ Emsg()

◆ exists()

◆ fsctl()

◆ getStats()

◆ getVersion()

◆ mkdir()

◆ newDir()

◆ newFile()

◆ prepare()

◆ rem()

◆ remdir()

◆ rename()

◆ setFeatures()

◆ setMax()

◆ Split()

◆ stat() [1/2]

◆ stat() [2/2]

◆ truncate()

Friends And Related Symbol Documentation

◆ XrdSsiFile

Member Data Documentation

◆ freeMax