XRootD
Loading...
Searching...
No Matches
XrdCl::FileSystemPlugIn Class Reference

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

#include <XrdClPlugInInterface.hh>

+ Inheritance diagram for XrdCl::FileSystemPlugIn:
+ Collaboration diagram for XrdCl::FileSystemPlugIn:

Public Member Functions

virtual ~FileSystemPlugIn ()
 Destructor.
 
virtual XRootDStatus ChMod (const std::string &path, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus DeepLocate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus DelXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus DirList (const std::string &path, DirListFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)
 
virtual bool GetProperty (const std::string &name, std::string &value) const
 
virtual XRootDStatus GetXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus ListXAttr (const std::string &path, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Locate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus MkDir (const std::string &path, MkDirFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Mv (const std::string &source, const std::string &dest, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Ping (ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Protocol (ResponseHandler *handler, uint16_t timeout=0)
 
virtual XRootDStatus Query (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Rm (const std::string &path, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus RmDir (const std::string &path, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus SendInfo (const std::string &info, ResponseHandler *handler, uint16_t timeout)
 
virtual bool SetProperty (const std::string &name, const std::string &value)
 
virtual XRootDStatus SetXAttr (const std::string &path, const std::vector< xattr_t > &attrs, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Stat (const std::string &path, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus StatVFS (const std::string &path, ResponseHandler *handler, uint16_t timeout)
 
virtual XRootDStatus Truncate (const std::string &path, uint64_t size, ResponseHandler *handler, uint16_t timeout)
 

Detailed Description

An interface for file plug-ins.

Definition at line 283 of file XrdClPlugInInterface.hh.

Constructor & Destructor Documentation

◆ ~FileSystemPlugIn()

virtual XrdCl::FileSystemPlugIn::~FileSystemPlugIn ( )
inlinevirtual

Destructor.

Definition at line 289 of file XrdClPlugInInterface.hh.

289{}

Member Function Documentation

◆ ChMod()

virtual XRootDStatus XrdCl::FileSystemPlugIn::ChMod ( const std::string & path,
Access::Mode mode,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::ChMod

Definition at line 389 of file XrdClPlugInInterface.hh.

393 {
394 (void)path; (void)mode; (void)handler; (void)timeout;
395 return XRootDStatus( stError, errNotImplemented );
396 }
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.

Referenced by XrdCl::FileSystem::ChMod().

+ Here is the caller graph for this function:

◆ DeepLocate()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DeepLocate ( const std::string & path,
OpenFlags::Flags flags,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::DeepLocate

Definition at line 306 of file XrdClPlugInInterface.hh.

310 {
311 (void)path; (void)flags; (void)handler; (void)timeout;
312 return XRootDStatus( stError, errNotImplemented );
313 }

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

◆ DelXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DelXAttr ( const std::string & path,
const std::vector< std::string > & attrs,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::DelXAttr

Definition at line 504 of file XrdClPlugInInterface.hh.

508 {
509 (void)path; (void)attrs; (void)handler; (void)timeout;
510 return XRootDStatus( stError, errNotImplemented );
511 }

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

◆ DirList()

virtual XRootDStatus XrdCl::FileSystemPlugIn::DirList ( const std::string & path,
DirListFlags::Flags flags,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::DirlList

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 443 of file XrdClPlugInInterface.hh.

447 {
448 (void)path; (void)flags; (void)handler; (void)timeout;
449 return XRootDStatus( stError, errNotImplemented );
450 }

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

Referenced by XrdCl::FileSystem::DirList().

+ Here is the caller graph for this function:

◆ GetProperty()

virtual bool XrdCl::FileSystemPlugIn::GetProperty ( const std::string & name,
std::string & value ) const
inlinevirtual
See also
XrdCl::FileSystem::GetProperty

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 537 of file XrdClPlugInInterface.hh.

539 {
540 (void)name; (void)value;
541 return false;
542 }

Referenced by XrdCl::FileSystem::GetProperty().

+ Here is the caller graph for this function:

◆ GetXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::GetXAttr ( const std::string & path,
const std::vector< std::string > & attrs,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::GetXAttr

Definition at line 492 of file XrdClPlugInInterface.hh.

496 {
497 (void)path; (void)attrs; (void)handler; (void)timeout;
498 return XRootDStatus( stError, errNotImplemented );
499 }

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

◆ ListXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::ListXAttr ( const std::string & path,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::ListXAttr

Definition at line 516 of file XrdClPlugInInterface.hh.

519 {
520 (void)path; (void)handler; (void)timeout;
521 return XRootDStatus( stError, errNotImplemented );
522 }

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

◆ Locate()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Locate ( const std::string & path,
OpenFlags::Flags flags,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Locate

Definition at line 294 of file XrdClPlugInInterface.hh.

298 {
299 (void)path; (void)flags; (void)handler; (void)timeout;
300 return XRootDStatus( stError, errNotImplemented );
301 }

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

Referenced by XrdCl::FileSystem::Locate().

+ Here is the caller graph for this function:

◆ MkDir()

virtual XRootDStatus XrdCl::FileSystemPlugIn::MkDir ( const std::string & path,
MkDirFlags::Flags flags,
Access::Mode mode,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::MkDir

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 365 of file XrdClPlugInInterface.hh.

370 {
371 (void)path; (void)flags; (void)mode; (void)handler; (void)timeout;
372 return XRootDStatus( stError, errNotImplemented );
373 }

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

Referenced by XrdCl::FileSystem::MkDir().

+ Here is the caller graph for this function:

◆ Mv()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Mv ( const std::string & source,
const std::string & dest,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Mv

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 318 of file XrdClPlugInInterface.hh.

322 {
323 (void)source; (void)dest; (void)handler; (void)timeout;
324 return XRootDStatus( stError, errNotImplemented );
325 }

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

Referenced by XrdCl::FileSystem::Mv().

+ Here is the caller graph for this function:

◆ Ping()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Ping ( ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Ping

Definition at line 401 of file XrdClPlugInInterface.hh.

403 {
404 (void)handler; (void)timeout;
405 return XRootDStatus( stError, errNotImplemented );
406 }

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

Referenced by XrdCl::FileSystem::Ping().

+ Here is the caller graph for this function:

◆ Prepare()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Prepare ( const std::vector< std::string > & fileList,
PrepareFlags::Flags flags,
uint8_t priority,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Prepare

Definition at line 466 of file XrdClPlugInInterface.hh.

471 {
472 (void)fileList; (void)flags; (void)priority; (void)handler;
473 (void)timeout;
474 return XRootDStatus( stError, errNotImplemented );
475 }

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

Referenced by XrdCl::FileSystem::Prepare().

+ Here is the caller graph for this function:

◆ Protocol()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Protocol ( ResponseHandler * handler,
uint16_t timeout = 0 )
inlinevirtual
See also
XrdCl::FileSystem::Protocol

Definition at line 433 of file XrdClPlugInInterface.hh.

435 {
436 (void)handler; (void)timeout;
437 return XRootDStatus( stError, errNotImplemented );
438 }

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

Referenced by XrdCl::FileSystem::Protocol().

+ Here is the caller graph for this function:

◆ Query()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Query ( QueryCode::Code queryCode,
const Buffer & arg,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Query

Definition at line 330 of file XrdClPlugInInterface.hh.

334 {
335 (void)queryCode; (void)arg; (void)handler; (void)timeout;
336 return XRootDStatus( stError, errNotImplemented );
337 }

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

Referenced by XrdCl::FileSystem::Query().

+ Here is the caller graph for this function:

◆ Rm()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Rm ( const std::string & path,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Rm

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 354 of file XrdClPlugInInterface.hh.

357 {
358 (void)path; (void)handler; (void)timeout;
359 return XRootDStatus( stError, errNotImplemented );
360 }

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

Referenced by XrdCl::FileSystem::Rm().

+ Here is the caller graph for this function:

◆ RmDir()

virtual XRootDStatus XrdCl::FileSystemPlugIn::RmDir ( const std::string & path,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::RmDir

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 378 of file XrdClPlugInInterface.hh.

381 {
382 (void)path; (void)handler; (void)timeout;
383 return XRootDStatus( stError, errNotImplemented );
384 }

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

Referenced by XrdCl::FileSystem::RmDir().

+ Here is the caller graph for this function:

◆ SendInfo()

virtual XRootDStatus XrdCl::FileSystemPlugIn::SendInfo ( const std::string & info,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::SendInfo

Definition at line 455 of file XrdClPlugInInterface.hh.

458 {
459 (void)info; (void)handler; (void)timeout;
460 return XRootDStatus( stError, errNotImplemented );
461 }

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

Referenced by XrdCl::FileSystem::SendInfo().

+ Here is the caller graph for this function:

◆ SetProperty()

virtual bool XrdCl::FileSystemPlugIn::SetProperty ( const std::string & name,
const std::string & value )
inlinevirtual
See also
XrdCl::FileSystem::SetProperty

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 527 of file XrdClPlugInInterface.hh.

529 {
530 (void)name; (void)value;
531 return false;
532 }

Referenced by XrdCl::FileSystem::SetProperty().

+ Here is the caller graph for this function:

◆ SetXAttr()

virtual XRootDStatus XrdCl::FileSystemPlugIn::SetXAttr ( const std::string & path,
const std::vector< xattr_t > & attrs,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::SetXAttr

Definition at line 480 of file XrdClPlugInInterface.hh.

484 {
485 (void)path; (void)attrs; (void)handler; (void)timeout;
486 return XRootDStatus( stError, errNotImplemented );
487 }

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

◆ Stat()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Stat ( const std::string & path,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Stat

Reimplemented in XrdCl::HttpFileSystemPlugIn.

Definition at line 411 of file XrdClPlugInInterface.hh.

414 {
415 (void)path; (void)handler; (void)timeout;
416 return XRootDStatus( stError, errNotImplemented );
417 }

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

Referenced by XrdCl::FileSystem::Stat().

+ Here is the caller graph for this function:

◆ StatVFS()

virtual XRootDStatus XrdCl::FileSystemPlugIn::StatVFS ( const std::string & path,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::StatVFS

Definition at line 422 of file XrdClPlugInInterface.hh.

425 {
426 (void)path; (void)handler; (void)timeout;
427 return XRootDStatus( stError, errNotImplemented );
428 }

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

Referenced by XrdCl::FileSystem::StatVFS().

+ Here is the caller graph for this function:

◆ Truncate()

virtual XRootDStatus XrdCl::FileSystemPlugIn::Truncate ( const std::string & path,
uint64_t size,
ResponseHandler * handler,
uint16_t timeout )
inlinevirtual
See also
XrdCl::FileSystem::Truncate

Definition at line 342 of file XrdClPlugInInterface.hh.

346 {
347 (void)path; (void)size; (void)handler; (void)timeout;
348 return XRootDStatus( stError, errNotImplemented );
349 }

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

Referenced by XrdCl::FileSystem::Truncate().

+ Here is the caller graph for this function:

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