XRootD
Loading...
Searching...
No Matches
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 Close (ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus Fcntl (const Buffer &arg, ResponseHandler *handler, uint16_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, uint16_t timeout)
virtual XRootDStatus PgRead (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus PgWrite (uint64_t offset, uint32_t nbpgs, const void *buffer, std::vector< uint32_t > &cksums, 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 Read (uint64_t offset, uint32_t size, void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual bool SetProperty (const std::string &name, const std::string &value)
virtual XRootDStatus Stat (bool force, 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 Visa (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, const void *buffer, ResponseHandler *handler, uint16_t timeout)
virtual XRootDStatus Write (uint64_t offset, uint32_t size, Optional< uint64_t > fdoff, int fd, ResponseHandler *handler, uint16_t timeout=0)
virtual XRootDStatus WriteV (uint64_t offset, const struct iovec *iov, int iovcnt, ResponseHandler *handler, uint16_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.

44{}

Member Function Documentation

◆ Close()

virtual XRootDStatus XrdCl::FilePlugIn::Close ( ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::File::Close

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

Definition at line 61 of file XrdClPlugInInterface.hh.

63 {
64 (void)handler; (void)timeout;
65 return XRootDStatus( stError, errNotImplemented );
66 }
const uint16_t errNotImplemented
Operation is not implemented.
const uint16_t stError
An error occurred that could potentially be retried.

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.

Definition at line 233 of file XrdClPlugInInterface.hh.

236 {
237 (void)arg; (void)handler; (void)timeout;
238 return XRootDStatus( stError, errNotImplemented );
239 }

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::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 272 of file XrdClPlugInInterface.hh.

274 {
275 (void)name; (void)value;
276 return false;
277 }
Response NullRef< Response >::value

References XrdCl::NullRef< Response >::value.

◆ IsOpen()

virtual bool XrdCl::FilePlugIn::IsOpen ( ) const
inlinevirtual
See also
XrdCl::File::IsOpen

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

Definition at line 254 of file XrdClPlugInInterface.hh.

255 {
256 return false;
257 }

◆ 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::EcHandler, XrdCl::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 48 of file XrdClPlugInInterface.hh.

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

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::EcHandler, XrdCl::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 109 of file XrdClPlugInInterface.hh.

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

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::EcHandler, XrdCl::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 161 of file XrdClPlugInInterface.hh.

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

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

Definition at line 95 of file XrdClPlugInInterface.hh.

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

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::EcHandler, XrdCl::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 82 of file XrdClPlugInInterface.hh.

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

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::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 262 of file XrdClPlugInInterface.hh.

264 {
265 (void)name; (void)value;
266 return false;
267 }

References XrdCl::NullRef< Response >::value.

◆ Stat()

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

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

Definition at line 71 of file XrdClPlugInInterface.hh.

74 {
75 (void)force; (void)handler; (void)timeout;
76 return XRootDStatus( stError, errNotImplemented );
77 }

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::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 175 of file XrdClPlugInInterface.hh.

177 {
178 (void)handler; (void)timeout;
179 return XRootDStatus( stError, errNotImplemented );
180 }

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.

Definition at line 185 of file XrdClPlugInInterface.hh.

188 {
189 (void)size; (void)handler; (void)timeout;
190 return XRootDStatus( stError, errNotImplemented );
191 }

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::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 196 of file XrdClPlugInInterface.hh.

200 {
201 (void)chunks; (void)buffer; (void)handler; (void)timeout;
202 return XRootDStatus( stError, errNotImplemented );
203 }

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.

Definition at line 208 of file XrdClPlugInInterface.hh.

211 {
212 (void)chunks; (void)handler; (void)timeout;
213 return XRootDStatus( stError, errNotImplemented );
214 }

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.

Definition at line 244 of file XrdClPlugInInterface.hh.

246 {
247 (void)handler; (void)timeout;
248 return XRootDStatus( stError, errNotImplemented );
249 }

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.

Definition at line 135 of file XrdClPlugInInterface.hh.

139 {
140 (void)offset; (void)buffer; (void)handler; (void)timeout;
141 return XRootDStatus( stError, errNotImplemented );
142 }

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::EcHandler, XrdCl::HttpFilePlugIn, XrdCl::Recorder, and xrdcl_proxy::ProxyPrefixFile.

Definition at line 122 of file XrdClPlugInInterface.hh.

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

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.

Definition at line 147 of file XrdClPlugInInterface.hh.

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

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.

Definition at line 220 of file XrdClPlugInInterface.hh.

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

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


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