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

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FilePlugIn:

[legend]

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	Read (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	PgRead (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	Write (uint64_t offset, Buffer &&buffer, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	PgWrite (uint64_t offset, uint32_t nbpgs, const void buffer, std::vector< uint32_t > &cksums, 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	VectorWrite (const ChunkList &chunks, ResponseHandler *handler, uint16_t timeout=0)

virtual XRootDStatus	WriteV (uint64_t offset, const struct iovec iov, int iovcnt, ResponseHandler handler, uint16_t timeout=0)

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

◆ ~FilePlugIn()

virtual XrdCl::FilePlugIn::~FilePlugIn ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Close()

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

inlinevirtual

See also: XrdCl::File::Close

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ Fcntl()

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

inlinevirtual

See also: XrdCl::File::Fcntl

Reimplemented in XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

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

◆ GetProperty()

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

inlinevirtual

See also: XrdCl::File::GetProperty

Reimplemented in XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

◆ IsOpen()

virtual bool XrdCl::FilePlugIn::IsOpen ( ) const

inlinevirtual

See also: XrdCl::File::IsOpen

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

◆ Open()

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

inlinevirtual

See also: XrdCl::File::Open

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ PgRead()

virtual XRootDStatus XrdCl::FilePlugIn::PgRead	(	uint64_t	offset,
		uint32_t	size,
		void *	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl:File PgRead

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ PgWrite()

virtual XRootDStatus XrdCl::FilePlugIn::PgWrite	(	uint64_t	offset,
		uint32_t	nbpgs,
		const void *	buffer,
		std::vector< uint32_t > &	cksums,
		ResponseHandler *	handler,
		uint16_t	timeout
	)

inlinevirtual

See also: XrdCl::File::PgWrite

Reimplemented in xrdcl_proxy::ProxyPrefixFile, XrdCl::Recorder, XrdCl::HttpFilePlugIn, and XrdCl::EcHandler.

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

◆ Read() [1/2]

virtual XRootDStatus XrdCl::FilePlugIn::Read	(	uint64_t	offset,
		uint32_t	size,
		Optional< uint64_t >	fdoff,
		int	fd,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::File::Read

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

◆ Read() [2/2]

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

inlinevirtual

See also: XrdCl::File::Read

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ SetProperty()

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

inlinevirtual

See also: XrdCl::File::SetProperty

Reimplemented in XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

◆ Stat()

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

inlinevirtual

See also: XrdCl::File::Stat

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ Sync()

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

inlinevirtual

See also: XrdCl::File::Sync

Reimplemented in XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ Truncate()

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

inlinevirtual

See also: XrdCl::File::Truncate

Reimplemented in XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

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

◆ VectorRead()

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

inlinevirtual

See also: XrdCl::File::VectorRead

Reimplemented in XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ VectorWrite()

virtual XRootDStatus XrdCl::FilePlugIn::VectorWrite	(	const ChunkList &	chunks,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::File::VectorWrite

Reimplemented in XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

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

◆ Visa()

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

inlinevirtual

See also: XrdCl::File::Visa

Reimplemented in XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

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

◆ Write() [1/3]

virtual XRootDStatus XrdCl::FilePlugIn::Write	(	uint64_t	offset,
		Buffer &&	buffer,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::File::Write

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

◆ Write() [2/3]

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

inlinevirtual

See also: XrdCl::File::Write

Reimplemented in XrdCl::Recorder, XrdCl::EcHandler, xrdcl_proxy::ProxyPrefixFile, and XrdCl::HttpFilePlugIn.

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

◆ Write() [3/3]

virtual XRootDStatus XrdCl::FilePlugIn::Write	(	uint64_t	offset,
		uint32_t	size,
		Optional< uint64_t >	fdoff,
		int	fd,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::File::Write

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

◆ WriteV()

virtual XRootDStatus XrdCl::FilePlugIn::WriteV	(	uint64_t	offset,
		const struct iovec *	iov,
		int	iovcnt,
		ResponseHandler *	handler,
		uint16_t	timeout = `0`
	)

inlinevirtual

See also: XrdCl::File::WriteV

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

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

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

XrdClPlugInInterface.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~FilePlugIn()

Member Function Documentation

◆ Close()

◆ Fcntl()

◆ GetProperty()

◆ IsOpen()

◆ Open()

◆ PgRead()

◆ PgWrite()

◆ Read() [1/2]

◆ Read() [2/2]

◆ SetProperty()

◆ Stat()

◆ Sync()

◆ Truncate()

◆ VectorRead()

◆ VectorWrite()

◆ Visa()

◆ Write() [1/3]

◆ Write() [2/3]

◆ Write() [3/3]

◆ WriteV()