inputHandler::dummy::readerDummy Class Reference

#include <inputHandlerDummy.h>

Inheritance diagram for inputHandler::dummy::readerDummy:

Collaboration diagram for inputHandler::dummy::readerDummy:

Public Member Functions
	readerDummy (const std::string &aPath, copyRequest::stateType &state, const genericStat &inititalStat)
	~readerDummy () override
bool	parallelizable () const override
	tell if this handler is capable of parallel IO. Unsually not the case More...
bool	readBlock (block &b) override
	read one block from the file More...
void	readBlockP (block &b, size_t bytesToRead, off_t offset) override
	read one block from the file, starting at offset. More...
void	checkUnchangedness () override
	check if the file is unchanged by comparing cuttent stat to initial stat More...
std::unique_ptr< const genericStat >	getStat () override
Public Member Functions inherited from inputHandler::base::reader
virtual	~reader () noexcept(false)=default
virtual bool	setupSparseRegions (const std::string &)
	set up internal list of data and hole regions, normally does nothing More...
virtual void	seek (size_t)
	like the standard seek, to be used only when appending new data to a file More...
Public Member Functions inherited from ioHandle
	ioHandle ()
virtual	~ioHandle () noexcept(false)
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< 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...

Private Attributes
size_t	size

Additional Inherited Members
Protected Member Functions inherited from inputHandler::base::reader
	reader (const genericStat &inititalStat)
Protected Member Functions inherited from unwindCheck
	unwindCheck ()=default
	~unwindCheck ()=default
bool	isUnwinding () const
Protected Member Functions inherited from ioHandle
	ioHandle ()
virtual	~ioHandle () noexcept(false)
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< 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 inherited from inputHandler::base::reader
const genericStat &	readInitialStat
	stat at beginning, needed for unchngedness check More...
std::remove_const< decltype(readInitialStat.size)>::type	totalBytesRead = 0
	number of bytes read so far, needed for check on growing files More...
Protected Attributes inherited from ioHandle
size_t	blockSize
	in bytes, block size to be used when reading or writing More...

Detailed Description

Definition at line 24 of file inputHandlerDummy.h.

Constructor & Destructor Documentation

readerDummy()

inputHandler::dummy::readerDummy::readerDummy	(	const std::string &	aPath,
		copyRequest::stateType &	state,
		const genericStat &	inititalStat
	)

Definition at line 56 of file inputHandlerDummy.cpp.

                                           :
        ioHandle(),
        reader(inititalStat) {
    }

~readerDummy()

inputHandler::dummy::readerDummy::~readerDummy ( )

override

Definition at line 63 of file inputHandlerDummy.cpp.

                                   {
    }

Member Function Documentation

checkUnchangedness()

void inputHandler::dummy::readerDummy::checkUnchangedness ( )

overridevirtual

check if the file is unchanged by comparing cuttent stat to initial stat

Exceptions

delayAdvisingError	if file has changed according to size of mtime
std::system_error	if stat fails

Implements inputHandler::base::reader.

Definition at line 109 of file inputHandlerDummy.cpp.

                                              {
    }

getStat()

std::unique_ptr< const genericStat > inputHandler::dummy::readerDummy::getStat ( )

overridevirtual

Implements ioHandle.

Definition at line 112 of file inputHandlerDummy.cpp.

                                                               {
        return std::unique_ptr<const genericStat>(new genericStat(readInitialStat));
    }

parallelizable()

bool inputHandler::dummy::readerDummy::parallelizable ( ) const

overridevirtual

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

Reimplemented from ioHandle.

Definition at line 68 of file inputHandlerDummy.cpp.

                                                {
        return true;
    }

readBlock()

bool inputHandler::dummy::readerDummy::readBlock ( block &  b )

overridevirtual

read one block from the file

Returns

true if the last block was read, false if more to follow

Exceptions

std::system_error	if read fails
delayAdvisingError	if file changes during reading

Implements inputHandler::base::reader.

Definition at line 71 of file inputHandlerDummy.cpp.

                                             {
        timerInst(read);
        b.clear(totalBytesRead);
        auto bytesToRead = readInitialStat.size - totalBytesRead;
        if (bytesToRead > b.max_size()) {
            bytesToRead = b.max_size();
        }
        if (! noCopy) {
            if (randomBlock().size() < bytesToRead) {
                throw std::runtime_error("random data block too small");
            }
            {
                timerInst(memcpy);
                memcpy(b.bufferAt(0), randomBlock().bufferAt(0), bytesToRead);
            }
        }
        b.bump_size(bytesToRead);
        totalBytesRead += bytesToRead;
        return totalBytesRead >= readInitialStat.size;
    }

References block::bufferAt(), block::bump_size(), block::clear(), block::max_size(), inputHandler::dummy::noCopy, inputHandler::dummy::randomBlock(), and timerInst.

Here is the call graph for this function:

readBlockP()

void inputHandler::dummy::readerDummy::readBlockP ( block &  , size_t  , off_t    )

overridevirtual

read one block from the file, starting at offset.

meant for pparallel reading, often not implemented only for non-sparse files

Exceptions

std::system_error	if read fails
delayAdvisingError	if file changes during reading
std::logic_error	if attempted on sparse file

Reimplemented from inputHandler::base::reader.

Definition at line 93 of file inputHandlerDummy.cpp.

                                                                                {
        timerInst(readp);
        b.clear(offset);
        if (! noCopy) {
            if (randomBlock().size() < bytesToRead) {
                throw std::runtime_error("random data block too small");
            }
            {
                timerInst(memcpy);
                memcpy(b.bufferAt(0), randomBlock().bufferAt(0), bytesToRead);
            }
        }
        b.bump_size(bytesToRead);
    }

References block::bufferAt(), block::bump_size(), block::clear(), inputHandler::dummy::noCopy, inputHandler::dummy::randomBlock(), and timerInst.

Here is the call graph for this function:

Member Data Documentation

size

size_t inputHandler::dummy::readerDummy::size

private

Definition at line 25 of file inputHandlerDummy.h.

---

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

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