ioHandle Class Reference

class as base for inputHandler::base::reader and outputHandler::base::writer containing the common parts of both classes More...

#include <ioHandle.h>

Inheritance diagram for ioHandle:

Classes
class	attrDataType
	class for asttribute data, abstract base to be implemented for specific handlers More...

Public Member Functions
	ioHandle ()
virtual	~ioHandle () noexcept(false)
virtual bool	parallelizable () const
	tell if this handler is capable of parallel IO. Unsually not the case More...
virtual void	setXattr (const std::string &, const std::string &)
virtual std::string	getXattr (const std::string &)
	get one extended attribute value More...
virtual void	removeXattr (const std::string &)
virtual size_t	getBlockSize () const
virtual void	setBlockSize (size_t newSize)
virtual std::unique_ptr< const genericStat >	getStat ()=0
virtual std::unique_ptr< attrDataType >	getAttrData (const outputHandler::base *)
	get attributes in the optimal way for setting with aOutputHandler More...
virtual std::unique_ptr< acl::list >	getAclData ()
	get acls More...

Protected Attributes
size_t	blockSize
	in bytes, block size to be used when reading or writing More...

Detailed Description

class as base for inputHandler::base::reader and outputHandler::base::writer containing the common parts of both classes

Definition at line 15 of file ioHandle.h.

Constructor & Destructor Documentation

ioHandle()

ioHandle::ioHandle ( )

inline

Definition at line 34 of file ioHandle.h.

: blockSize(16 * 1024 * 1024) {};

~ioHandle()

virtual ioHandle::~ioHandle ( )

inlinevirtualnoexcept

Definition at line 35 of file ioHandle.h.

{};

Member Function Documentation

getAclData()

virtual std::unique_ptr<acl::list> ioHandle::getAclData ( )

inlinevirtual

get acls

Returns

std::unique_ptr to the acl data or nullptr if none available

Exceptions

std::system_error

when reading of acls fails

Reimplemented in gpfsIoCommon.

Definition at line 77 of file ioHandle.h.

                                                {
        return nullptr;
    }

getAttrData()

virtual std::unique_ptr<attrDataType> ioHandle::getAttrData ( const outputHandler::base *  )

inlinevirtual

get attributes in the optimal way for setting with aOutputHandler

Returns

std::unique_ptr to the attribute data or nullptr if none available

Exceptions

std::system_error

when reading of attributes fails

Reimplemented in daosFsIoCommon, posixFileIoCommon, and gpfsIoCommon.

Definition at line 69 of file ioHandle.h.

                                                       {
        return nullptr;
    };

Referenced by posixFileIoCommon::getAttrData().

Here is the caller graph for this function:

getBlockSize()

virtual size_t ioHandle::getBlockSize ( ) const

inlinevirtual

Definition at line 58 of file ioHandle.h.

                                        {
        return (blockSize);
    };

References blockSize.

Referenced by copyRequest::base::doBlockSizeSetup(), and outputHandler::Gpfs::writerGpfs::doSpecialFdHandling().

Here is the caller graph for this function:

getStat()

virtual std::unique_ptr<const genericStat> ioHandle::getStat ( )

pure virtual

Implemented in davixIoCommon, dcapIoCommon, daosFsIoCommon, libsshIoCommon, posixFileIoCommon, and inputHandler::dummy::readerDummy.

getXattr()

virtual std::string ioHandle::getXattr ( const std::string &  )

inlinevirtual

get one extended attribute value

Returns

value or empty string if attribute not present

Exceptions

std::system_error	if attribute setting fails
unimplementedActionError	if not implemented (most handlers)

Reimplemented in daosFsIoCommon, and posixFileIoCommon.

Definition at line 51 of file ioHandle.h.

                                  {
        throw unimplementedActionError("xattr getting not implemented");
    };

Referenced by copyRequest::base::attrset(), and copyRequest::base::checkAttributes().

Here is the caller graph for this function:

parallelizable()

virtual bool ioHandle::parallelizable ( ) const

inlinevirtual

tell if this handler is capable of parallel IO. Unsually not the case

Reimplemented in inputHandler::posixFile::readerPosixFile, outputHandler::daosFs::writerDaosFs, outputHandler::posixFile::writerPosixFile, inputHandler::dummy::readerDummy, inputHandler::daosFs::readerDaosFs, and inputHandler::davix::readerDavix.

Definition at line 38 of file ioHandle.h.

                                        {
        return false;
    }

Referenced by copyRequest::base::doThreadedCopy(), copyRequest::base::reader(), and copyRequest::base::writeActor::writeActor().

Here is the caller graph for this function:

removeXattr()

virtual void ioHandle::removeXattr ( const std::string &  )

inlinevirtual

Reimplemented in daosFsIoCommon, and posixFileIoCommon.

Definition at line 55 of file ioHandle.h.

                                                 {
        throw unimplementedActionError("xattr removal not implemented");
    };

Referenced by copyRequest::base::attrdel().

Here is the caller graph for this function:

setBlockSize()

virtual void ioHandle::setBlockSize ( size_t  newSize )

inlinevirtual

Definition at line 61 of file ioHandle.h.

                                              {
        blockSize = newSize;
    };

References blockSize.

Referenced by copyRequest::base::doBlockSizeSetup().

Here is the caller graph for this function:

setXattr()

virtual void ioHandle::setXattr ( const std::string &  , const std::string &    )

inlinevirtual

Reimplemented in daosFsIoCommon, and posixFileIoCommon.

Definition at line 43 of file ioHandle.h.

                                                                  {
        throw unimplementedActionError("xattr setting not implemented");
    };

Referenced by copyRequest::base::attrset(), posixFileIoCommon::attrDataType::set(), and daosFsIoCommon::attrDataType::set().

Here is the caller graph for this function:

Member Data Documentation

blockSize

size_t ioHandle::blockSize

protected

in bytes, block size to be used when reading or writing

Definition at line 17 of file ioHandle.h.

Referenced by getBlockSize(), inputHandler::daosFs::readerDaosFs::readerDaosFs(), inputHandler::davix::readerDavix::readerDavix(), inputHandler::dcap::readerDcap::readerDcap(), inputHandler::libssh::readerLibssh::readerLibssh(), inputHandler::posixFile::readerPosixFile::readerPosixFile(), setBlockSize(), outputHandler::daosFs::writerDaosFs::writerDaosFs(), outputHandler::dcap::writerDcap::writerDcap(), outputHandler::libssh::writerLibssh::writerLibssh(), and outputHandler::posixFile::writerPosixFile::writerPosixFile().

---

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

• src/ioHandle.h (v0.19-24-g0617ca1 with changes)