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

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FileSystemPlugIn:

Collaboration diagram for XrdCl::FileSystemPlugIn:

Public Member Functions
virtual	~FileSystemPlugIn ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

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

virtual XRootDStatus	Ping (ResponseHandler *handler, time_t timeout)

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

An interface for file plug-ins.

Definition at line 345 of file XrdClPlugInInterface.hh.

Constructor & Destructor Documentation

◆ ~FileSystemPlugIn()

virtual XrdCl::FileSystemPlugIn::~FileSystemPlugIn ( )

inlinevirtual

Destructor.

Definition at line 351 of file XrdClPlugInInterface.hh.

351 {}

Member Function Documentation

◆ ChMod()

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

inlinevirtual

See also: XrdCl::FileSystem::ChMod

Definition at line 451 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)mode; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::ChMod().

Here is the caller graph for this function:

◆ DeepLocate()

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

inlinevirtual

See also: XrdCl::FileSystem::DeepLocate

Definition at line 368 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)flags; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

◆ DelXAttr()

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

inlinevirtual

See also: XrdCl::FileSystem::DelXAttr

Definition at line 566 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)attrs; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

◆ DirList()

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

inlinevirtual

See also: XrdCl::FileSystem::DirlList

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 505 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)flags; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::DirList().

Here is the caller graph for this function:

◆ GetProperty()

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

inlinevirtual

See also: XrdCl::FileSystem::GetProperty

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 599 of file XrdClPlugInInterface.hh.

       {
         (void)name; (void)value;
         return false;
       }

Referenced by XrdCl::FileSystem::GetProperty().

Here is the caller graph for this function:

◆ GetXAttr()

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

inlinevirtual

See also: XrdCl::FileSystem::GetXAttr

Definition at line 554 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)attrs; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

◆ ListXAttr()

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

inlinevirtual

See also: XrdCl::FileSystem::ListXAttr

Definition at line 578 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

◆ Locate()

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

inlinevirtual

See also: XrdCl::FileSystem::Locate

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 356 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)flags; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Locate().

Here is the caller graph for this function:

◆ MkDir()

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

inlinevirtual

See also: XrdCl::FileSystem::MkDir

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 427 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)flags; (void)mode; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::MkDir().

Here is the caller graph for this function:

◆ Mv()

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

inlinevirtual

See also: XrdCl::FileSystem::Mv

Definition at line 380 of file XrdClPlugInInterface.hh.

       {
         (void)source; (void)dest; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Mv().

Here is the caller graph for this function:

◆ Ping()

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

inlinevirtual

See also: XrdCl::FileSystem::Ping

Definition at line 463 of file XrdClPlugInInterface.hh.

       {
         (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Ping().

Here is the caller graph for this function:

◆ Prepare()

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

inlinevirtual

See also: XrdCl::FileSystem::Prepare

Definition at line 528 of file XrdClPlugInInterface.hh.

       {
         (void)fileList; (void)flags; (void)priority; (void)handler;
         (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Prepare().

Here is the caller graph for this function:

◆ Protocol()

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

inlinevirtual

See also: XrdCl::FileSystem::Protocol

Definition at line 495 of file XrdClPlugInInterface.hh.

       {
         (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Protocol().

Here is the caller graph for this function:

◆ Query()

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

inlinevirtual

See also: XrdCl::FileSystem::Query

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 392 of file XrdClPlugInInterface.hh.

       {
         (void)queryCode; (void)arg; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Query().

Here is the caller graph for this function:

◆ Rm()

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

inlinevirtual

See also: XrdCl::FileSystem::Rm

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 416 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Rm().

Here is the caller graph for this function:

◆ RmDir()

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

inlinevirtual

See also: XrdCl::FileSystem::RmDir

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 440 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::RmDir().

Here is the caller graph for this function:

◆ SendInfo()

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

inlinevirtual

See also: XrdCl::FileSystem::SendInfo

Definition at line 517 of file XrdClPlugInInterface.hh.

       {
         (void)info; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::SendInfo().

Here is the caller graph for this function:

◆ SetProperty()

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

inlinevirtual

See also: XrdCl::FileSystem::SetProperty

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 589 of file XrdClPlugInInterface.hh.

       {
         (void)name; (void)value;
         return false;
       }

Referenced by XrdCl::FileSystem::SetProperty().

Here is the caller graph for this function:

◆ SetXAttr()

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

inlinevirtual

See also: XrdCl::FileSystem::SetXAttr

Definition at line 542 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)attrs; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

◆ Stat()

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

inlinevirtual

See also: XrdCl::FileSystem::Stat

Reimplemented in XrdClS3::Filesystem, and XrdClHttp::Filesystem.

Definition at line 473 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Stat().

Here is the caller graph for this function:

◆ StatVFS()

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

inlinevirtual

See also: XrdCl::FileSystem::StatVFS

Definition at line 484 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::StatVFS().

Here is the caller graph for this function:

◆ Truncate()

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

inlinevirtual

See also: XrdCl::FileSystem::Truncate

Definition at line 404 of file XrdClPlugInInterface.hh.

       {
         (void)path; (void)size; (void)handler; (void)timeout;
         return XRootDStatus( stError, errNotImplemented );
       }

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

Referenced by XrdCl::FileSystem::Truncate().

Here is the caller graph for this function:

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

XrdClPlugInInterface.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~FileSystemPlugIn()

Member Function Documentation

◆ ChMod()

◆ DeepLocate()

◆ DelXAttr()

◆ DirList()

◆ GetProperty()

◆ GetXAttr()

◆ ListXAttr()

◆ Locate()

◆ MkDir()

◆ Mv()

◆ Ping()

◆ Prepare()

◆ Protocol()

◆ Query()

◆ Rm()

◆ RmDir()

◆ SendInfo()

◆ SetProperty()

◆ SetXAttr()

◆ Stat()

◆ StatVFS()

◆ Truncate()