XrdCl::FilePlugIn Class Reference

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

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FilePlugIn:

Collaboration diagram for XrdCl::FilePlugIn:

Public Member Functions
virtual	~FilePlugIn ()
	Destructor.
virtual XRootDStatus	Clone (const CloneLocations &locs, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Close (ResponseHandler *handler, time_t timeout)
virtual std::unique_ptr< ExportedFileTemplate >	ExportTemplate () const
virtual XRootDStatus	Fcntl (const Buffer &arg, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Fcntl (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, time_t timeout)
virtual bool	GetProperty (const std::string &name, std::string &value) const
virtual bool	IsOpen () const
virtual XRootDStatus	Open (const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	OpenUsingTemplate (ExportedFileTemplate *templ, const std::string &url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	PgRead (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	PgWrite (uint64_t offset, uint32_t nbpgs, const void *buffer, std::vector< uint32_t > &cksums, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	PreRead (const TractList &tracts, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Read (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	Read (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, time_t timeout)
virtual bool	SetProperty (const std::string &name, const std::string &value)
virtual XRootDStatus	Stat (bool force, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Sync (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Truncate (uint64_t size, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	VectorRead (const ChunkList &chunks, void *buffer, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	VectorWrite (const ChunkList &chunks, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	Visa (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Write (uint64_t offset, Buffer &&buffer, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	Write (uint64_t offset, uint32_t size, const void *buffer, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus	Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus	WriteV (uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, time_t timeout=0)

Detailed Description

An interface for file plug-ins.

Definition at line 38 of file XrdClPlugInInterface.hh.

Constructor & Destructor Documentation

~FilePlugIn()

virtual XrdCl::FilePlugIn::~FilePlugIn ( )

inlinevirtual

Destructor.

Definition at line 44 of file XrdClPlugInInterface.hh.

{}

Member Function Documentation

Clone()

virtual XRootDStatus XrdCl::FilePlugIn::Clone ( const CloneLocations & locs, ResponseHandler * handler, time_t timeout )

inlinevirtual

See also

XrdCl::File::Clone

Definition at line 335 of file XrdClPlugInInterface.hh.

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

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

Close()

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

inlinevirtual

See also

XrdCl::File::Close

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 75 of file XrdClPlugInInterface.hh.

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

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

ExportTemplate()

virtual std::unique_ptr< ExportedFileTemplate > XrdCl::FilePlugIn::ExportTemplate ( ) const

inlinevirtual

Obtains an object that contains information regarding the file. Another instance of the plugin can use the object via OpenUsingTemplate or Clone. The returned object should be of a class derived from ExportedFileTemplate, the exact type of which could be used to ensure the source plugin is the same the destination. In the case of Clone() it should be considered that the source file object may have been destroyed by the time Clone() uses the template and a suitable action should happen, such as returning an error.

Definition at line 327 of file XrdClPlugInInterface.hh.

      {
        return {};
      }

Fcntl() [1/2]

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

inlinevirtual

See also

XrdCl::File::Fcntl

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

Definition at line 259 of file XrdClPlugInInterface.hh.

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

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

Fcntl() [2/2]

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

inlinevirtual

See also

XrdCl::File::Fcntl

Definition at line 270 of file XrdClPlugInInterface.hh.

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

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, XrdClHttp::File, and XrdClS3::File.

Definition at line 310 of file XrdClPlugInInterface.hh.

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

IsOpen()

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

inlinevirtual

See also

XrdCl::File::IsOpen

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 292 of file XrdClPlugInInterface.hh.

      {
        return false;
      }

Open()

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

inlinevirtual

See also

XrdCl::File::Open

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 48 of file XrdClPlugInInterface.hh.

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

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

OpenUsingTemplate()

virtual XRootDStatus XrdCl::FilePlugIn::OpenUsingTemplate ( ExportedFileTemplate * templ, const std::string & url, OpenFlags::Flags flags, Access::Mode mode, ResponseHandler * handler, time_t timeout )

inlinevirtual

See also

XrdCl::File::OpenUsingTemplate

Definition at line 61 of file XrdClPlugInInterface.hh.

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

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

PgRead()

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

inlinevirtual

See also

XrdCl:File PgRead

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 123 of file XrdClPlugInInterface.hh.

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

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, time_t timeout )

inlinevirtual

See also

XrdCl::File::PgWrite

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

Definition at line 175 of file XrdClPlugInInterface.hh.

      {
        (void)offset; (void)nbpgs; (void)buffer; (void)cksums, (void)handler; (void)timeout;
        return XRootDStatus( stError, errNotImplemented );
      }

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

PreRead()

virtual XRootDStatus XrdCl::FilePlugIn::PreRead ( const TractList & tracts, ResponseHandler * handler, time_t timeout )

inlinevirtual

See also

XrdCl::File::PreRead

Definition at line 210 of file XrdClPlugInInterface.hh.

      {
        (void)tracts; (void)handler; (void)timeout;
        return XRootDStatus();
      }

Read() [1/2]

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

inlinevirtual

See also

XrdCl::File::Read

Definition at line 109 of file XrdClPlugInInterface.hh.

      {
        (void)offset; (void)size; (void)fdoff; (void)fd, (void)handler; (void)timeout;
        return XRootDStatus( stError, errNotImplemented );
      }

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

Read() [2/2]

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

inlinevirtual

See also

XrdCl::File::Read

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 96 of file XrdClPlugInInterface.hh.

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

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, XrdClHttp::File, and XrdClS3::File.

Definition at line 300 of file XrdClPlugInInterface.hh.

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

Stat()

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

inlinevirtual

See also

XrdCl::File::Stat

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 85 of file XrdClPlugInInterface.hh.

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

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

Sync()

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

inlinevirtual

See also

XrdCl::File::Sync

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

Definition at line 189 of file XrdClPlugInInterface.hh.

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

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

Truncate()

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

inlinevirtual

See also

XrdCl::File::Truncate

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

Definition at line 199 of file XrdClPlugInInterface.hh.

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

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

VectorRead()

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

inlinevirtual

See also

XrdCl::File::VectorRead

Reimplemented in XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 222 of file XrdClPlugInInterface.hh.

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

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

VectorWrite()

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

inlinevirtual

See also

XrdCl::File::VectorWrite

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

Definition at line 234 of file XrdClPlugInInterface.hh.

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

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

Visa()

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

inlinevirtual

See also

XrdCl::File::Visa

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

Definition at line 282 of file XrdClPlugInInterface.hh.

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

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

Write() [1/3]

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

inlinevirtual

See also

XrdCl::File::Write

Reimplemented in xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 149 of file XrdClPlugInInterface.hh.

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

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, time_t timeout )

inlinevirtual

See also

XrdCl::File::Write

Reimplemented in XrdCl::EcHandler, XrdCl::Recorder, xrdcl_proxy::ProxyPrefixFile, XrdClHttp::File, and XrdClS3::File.

Definition at line 136 of file XrdClPlugInInterface.hh.

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

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, time_t timeout = 0 )

inlinevirtual

See also

XrdCl::File::Write

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

Definition at line 161 of file XrdClPlugInInterface.hh.

      {
        (void)offset; (void)size; (void)fdoff; (void)fd, (void)handler; (void)timeout;
        return XRootDStatus( stError, errNotImplemented );
      }

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

WriteV()

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

inlinevirtual

See also

XrdCl::File::WriteV

Reimplemented in xrdcl_proxy::ProxyPrefixFile.

Definition at line 246 of file XrdClPlugInInterface.hh.

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

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

---

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

• XrdClPlugInInterface.hh