xrootd
Public Member Functions | List of all members
XrdCl::FilePlugIn Class Reference

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

#include <XrdClPlugInInterface.hh>

Inheritance diagram for XrdCl::FilePlugIn:
Inheritance graph
[legend]

Public Member Functions

virtual ~FilePlugIn ()
 Destructor. More...
 
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

◆ ~FilePlugIn()

virtual XrdCl::FilePlugIn::~FilePlugIn ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Close()

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

◆ Fcntl()

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

◆ GetProperty()

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

◆ IsOpen()

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

◆ Open()

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

◆ Read()

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

◆ SetProperty()

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

◆ Stat()

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

◆ Sync()

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

◆ Truncate()

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

◆ VectorRead()

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

◆ Visa()

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

◆ Write()

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

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