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, time_t timeout)
virtual XRootDStatus DeepLocate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus DelXAttr (const std::string &path, const std::vector< std::string > &attrs, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus DirList (const std::string &path, DirListFlags::Flags flags, ResponseHandler *handler, time_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, time_t timeout)
virtual XRootDStatus ListXAttr (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Locate (const std::string &path, OpenFlags::Flags flags, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus MkDir (const std::string &path, MkDirFlags::Flags flags, Access::Mode mode, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Mv (const std::string &source, const std::string &dest, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Ping (ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Prepare (const std::vector< std::string > &fileList, PrepareFlags::Flags flags, uint8_t priority, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Protocol (ResponseHandler *handler, time_t timeout=0)
virtual XRootDStatus Query (QueryCode::Code queryCode, const Buffer &arg, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Rm (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus RmDir (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus SendInfo (const std::string &info, ResponseHandler *handler, time_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, time_t timeout)
virtual XRootDStatus Stat (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus StatVFS (const std::string &path, ResponseHandler *handler, time_t timeout)
virtual XRootDStatus Truncate (const std::string &path, uint64_t size, ResponseHandler *handler, time_t timeout)

Detailed Description

An interface for file plug-ins.

Definition at line 345 of file XrdClPlugInInterface.hh.

Constructor & Destructor Documentation

◆ ~FileSystemPlugIn()

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

Destructor.

Definition at line 351 of file XrdClPlugInInterface.hh.

351{}

Member Function Documentation

◆ ChMod()

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

Definition at line 451 of file XrdClPlugInInterface.hh.

455 {
456 (void)path; (void)mode; (void)handler; (void)timeout;
457 return XRootDStatus( stError, errNotImplemented );
458 }
XrdCl::errNotImplemented
const uint16_t errNotImplemented
Operation is not implemented.
Definition XrdClStatus.hh:64
XrdCl::stError
const uint16_t stError
An error occurred that could potentially be retried.
Definition XrdClStatus.hh:32

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

◆ DeepLocate()

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

Definition at line 368 of file XrdClPlugInInterface.hh.

372 {
373 (void)path; (void)flags; (void)handler; (void)timeout;
374 return XRootDStatus( stError, errNotImplemented );
375 }

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

◆ DelXAttr()

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

Definition at line 566 of file XrdClPlugInInterface.hh.

570 {
571 (void)path; (void)attrs; (void)handler; (void)timeout;
572 return XRootDStatus( stError, errNotImplemented );
573 }

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

◆ DirList()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 505 of file XrdClPlugInInterface.hh.

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

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

◆ GetProperty()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 599 of file XrdClPlugInInterface.hh.

601 {
602 (void)name; (void)value;
603 return false;
604 }

◆ GetXAttr()

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

Definition at line 554 of file XrdClPlugInInterface.hh.

558 {
559 (void)path; (void)attrs; (void)handler; (void)timeout;
560 return XRootDStatus( stError, errNotImplemented );
561 }

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

◆ ListXAttr()

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

Definition at line 578 of file XrdClPlugInInterface.hh.

581 {
582 (void)path; (void)handler; (void)timeout;
583 return XRootDStatus( stError, errNotImplemented );
584 }

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

◆ Locate()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 356 of file XrdClPlugInInterface.hh.

360 {
361 (void)path; (void)flags; (void)handler; (void)timeout;
362 return XRootDStatus( stError, errNotImplemented );
363 }

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

◆ MkDir()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 427 of file XrdClPlugInInterface.hh.

432 {
433 (void)path; (void)flags; (void)mode; (void)handler; (void)timeout;
434 return XRootDStatus( stError, errNotImplemented );
435 }

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

◆ Mv()

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

Definition at line 380 of file XrdClPlugInInterface.hh.

384 {
385 (void)source; (void)dest; (void)handler; (void)timeout;
386 return XRootDStatus( stError, errNotImplemented );
387 }

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

◆ Ping()

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

Definition at line 463 of file XrdClPlugInInterface.hh.

465 {
466 (void)handler; (void)timeout;
467 return XRootDStatus( stError, errNotImplemented );
468 }

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

◆ Prepare()

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

Definition at line 528 of file XrdClPlugInInterface.hh.

533 {
534 (void)fileList; (void)flags; (void)priority; (void)handler;
535 (void)timeout;
536 return XRootDStatus( stError, errNotImplemented );
537 }

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

◆ Protocol()

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

Definition at line 495 of file XrdClPlugInInterface.hh.

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

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

◆ Query()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 392 of file XrdClPlugInInterface.hh.

396 {
397 (void)queryCode; (void)arg; (void)handler; (void)timeout;
398 return XRootDStatus( stError, errNotImplemented );
399 }

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

◆ Rm()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 416 of file XrdClPlugInInterface.hh.

419 {
420 (void)path; (void)handler; (void)timeout;
421 return XRootDStatus( stError, errNotImplemented );
422 }

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

◆ RmDir()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 440 of file XrdClPlugInInterface.hh.

443 {
444 (void)path; (void)handler; (void)timeout;
445 return XRootDStatus( stError, errNotImplemented );
446 }

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

◆ SendInfo()

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

Definition at line 517 of file XrdClPlugInInterface.hh.

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

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

◆ SetProperty()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 589 of file XrdClPlugInInterface.hh.

591 {
592 (void)name; (void)value;
593 return false;
594 }

◆ SetXAttr()

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

Definition at line 542 of file XrdClPlugInInterface.hh.

546 {
547 (void)path; (void)attrs; (void)handler; (void)timeout;
548 return XRootDStatus( stError, errNotImplemented );
549 }

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

◆ Stat()

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

Reimplemented in XrdClHttp::Filesystem, and XrdClS3::Filesystem.

Definition at line 473 of file XrdClPlugInInterface.hh.

476 {
477 (void)path; (void)handler; (void)timeout;
478 return XRootDStatus( stError, errNotImplemented );
479 }

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

◆ StatVFS()

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

Definition at line 484 of file XrdClPlugInInterface.hh.

487 {
488 (void)path; (void)handler; (void)timeout;
489 return XRootDStatus( stError, errNotImplemented );
490 }

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

◆ Truncate()

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

Definition at line 404 of file XrdClPlugInInterface.hh.

408 {
409 (void)path; (void)size; (void)handler; (void)timeout;
410 return XRootDStatus( stError, errNotImplemented );
411 }

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

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