An interface for file plug-ins. More...

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FileSystemPlugIn:

Public Member Functions
virtual	~FileSystemPlugIn ()
	Destructor.

virtual XRootDStatus	Locate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	DeepLocate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Mv (const std::string &source, const std::string &dest, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Query (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Truncate (const std::string &path, uint64_t size, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Rm (const std::string &path, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	MkDir (const std::string &path, MkDirFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	RmDir (const std::string &path, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	ChMod (const std::string &path, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Ping (ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Stat (const std::string &path, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	StatVFS (const std::string &path, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Protocol (ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	DirList (const std::string &path, DirListFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	SendInfo (const std::string &info, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	SetXAttr (const std::string &path, const std::vector< xattr_t > &attrs, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	GetXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	DelXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout)

virtual XRootDStatus	ListXAttr (const std::string &path, ResponseHandler *handler, uint16_t timeout)

virtual bool	SetProperty (const std::string &name, const std::string &value)

virtual bool	GetProperty (const std::string &name, std::string &value) const

Detailed Description

An interface for file plug-ins.

Constructor & Destructor Documentation

◆ ~FileSystemPlugIn()

virtual XrdCl::FileSystemPlugIn::~FileSystemPlugIn ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ ChMod()

virtual XRootDStatus XrdCl::FileSystemPlugIn::ChMod	(	const std::string &	path,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::ChMod

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ DeepLocate()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DeepLocate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::DeepLocate

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ DelXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DelXAttr	(	const std::string &	path,
		const std::vector< std::string > &	attrs,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::DelXAttr

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ DirList()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DirList	(	const std::string &	path,
		DirListFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::DirlList

Reimplemented in XrdCl::HttpFileSystemPlugIn.

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ GetProperty()

virtual bool XrdCl::FileSystemPlugIn::GetProperty	(	const std::string &	name,
		std::string &	value
	)		const

inlinevirtual

See also: XrdCl::FileSystem::GetProperty

Reimplemented in XrdCl::HttpFileSystemPlugIn.

◆ GetXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::GetXAttr	(	const std::string &	path,
		const std::vector< std::string > &	attrs,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::GetXAttr

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ ListXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::ListXAttr	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::ListXAttr

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Locate()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Locate	(	const std::string &	path,
		OpenFlags::Flags	flags,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Locate

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ MkDir()

virtual XRootDStatus XrdCl::FileSystemPlugIn::MkDir	(	const std::string &	path,
		MkDirFlags::Flags	flags,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::MkDir

Reimplemented in XrdCl::HttpFileSystemPlugIn.

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Mv()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Mv	(	const std::string &	source,
		const std::string &	dest,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Mv

Reimplemented in XrdCl::HttpFileSystemPlugIn.

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Ping()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Ping	(	ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Ping

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Prepare()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Prepare	(	const std::vector< std::string > &	fileList,
		PrepareFlags::Flags	flags,
		uint8_t	priority,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Prepare

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Protocol()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Protocol	(	ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::FileSystem::Protocol

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Query()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Query	(	QueryCode::Code	queryCode,
		const Buffer &	arg,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Query

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ Rm()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Rm	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::Rm

Reimplemented in XrdCl::HttpFileSystemPlugIn.

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ RmDir()

virtual XRootDStatus XrdCl::FileSystemPlugIn::RmDir	(	const std::string &	path,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::RmDir

Reimplemented in XrdCl::HttpFileSystemPlugIn.

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ SendInfo()

virtual XRootDStatus XrdCl::FileSystemPlugIn::SendInfo	(	const std::string &	info,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::FileSystem::SendInfo

References XrdCl::errNotImplemented, and XrdCl::stError.

◆ SetProperty()

virtual bool XrdCl::FileSystemPlugIn::SetProperty	(	const std::string &	name,
		const std::string &	value
	)

inlinevirtual

See also: XrdCl::FileSystem::SetProperty

Reimplemented in XrdCl::HttpFileSystemPlugIn.

◆ SetXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::SetXAttr	(	const std::string &	path,
		const std::vector< xattr_t > &	attrs,
		ResponseHandler *	handler,
		uint16_t	timeout
	)