XrdCl::FilePlugIn Class Reference

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

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FilePlugIn:

[legend]

List of all members.

Public Member Functions
virtual	~FilePlugIn ()
	Destructor.
virtual XRootDStatus	Open (const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Close (ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Stat (bool force, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Read (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Write (uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Sync (ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Truncate (uint64_t size, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	VectorRead (const ChunkList &chunks, void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Fcntl (const Buffer &arg, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus	Visa (ResponseHandler *handler, uint16_t timeout)
virtual bool	IsOpen () const
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

virtual XrdCl::FilePlugIn::~FilePlugIn

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual XRootDStatus XrdCl::FilePlugIn::Close	(	ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Close

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::Fcntl	(	const Buffer &	arg,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Fcntl

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual bool XrdCl::FilePlugIn::GetProperty	(	const std::string &	name,
		std::string &	value
	)			const [inline, virtual]

See also:

XrdCl::File::GetProperty

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

virtual bool XrdCl::FilePlugIn::IsOpen

(

)

const [inline, virtual]

See also:

XrdCl::File::IsOpen

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

virtual XRootDStatus XrdCl::FilePlugIn::Open	(	const std::string &	url,
		OpenFlags::Flags	flags,
		Access::Mode	mode,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Open

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::Read	(	uint64_t	offset,
		uint32_t	size,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Read

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual bool XrdCl::FilePlugIn::SetProperty	(	const std::string &	name,
		const std::string &	value
	)			[inline, virtual]

See also:

XrdCl::File::SetProperty

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

virtual XRootDStatus XrdCl::FilePlugIn::Stat	(	bool	force,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Stat

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::Sync	(	ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Sync

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::Truncate	(	uint64_t	size,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Truncate

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::VectorRead	(	const ChunkList &	chunks,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::VectorRead

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

virtual XRootDStatus XrdCl::FilePlugIn::Visa	(	ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Visa

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

virtual XRootDStatus XrdCl::FilePlugIn::Write	(	uint64_t	offset,
		uint32_t	size,
		const void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)			[inline, virtual]

See also:

XrdCl::File::Write

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

---

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

• XrdClPlugInInterface.hh