inputHandler::libssh::readerLibssh Class Reference

#include <inputHandlerLibssh.h>

Inheritance diagram for inputHandler::libssh::readerLibssh:

Collaboration diagram for inputHandler::libssh::readerLibssh:

Public Member Functions
	readerLibssh (const std::string &aPath, libsshCommon &aHandler, copyRequest::stateType &state, const genericStat &inititalStat)
	~readerLibssh () override
void	seek (size_t pos) override
bool	readBlock (block &b) override
void	checkUnchangedness () override
Public Member Functions inherited from libsshIoCommon
	libsshIoCommon (const std::string &aPath, libsshCommon &aHandler)
std::unique_ptr< const genericStat >	getStat () override
Public Member Functions inherited from ioHandle
	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< 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...

Additional Inherited Members
Protected Attributes inherited from libsshIoCommon
libsshCommon &	handler
const std::string	path
sftp_file	file
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 18 of file inputHandlerLibssh.h.

Constructor & Destructor Documentation

readerLibssh()

inputHandler::libssh::readerLibssh::readerLibssh	(	const std::string &	aPath,
		libsshCommon &	aHandler,
		copyRequest::stateType &	state,
		const genericStat &	inititalStat
	)

Definition at line 57 of file inputHandlerLibssh.cpp.

                                                                      :
        libsshIoCommon(aPath, aHandler),
        reader(inititalStat) {
        file = sftp_open(handler.sftp, path.c_str(), O_RDONLY, 0);
        if (file == nullptr) {
            if (sftp_get_error(handler.sftp) == SSH_FX_NO_SUCH_FILE) {
                state |= copyRequest::stateBitType::vanished;
            }
        }
        throwcall::sftp::badval(file, nullptr, handler, "can't open ", path, " for reading");
        blockSize = readInitialStat.blksize;
    }

References throwcall::sftp::badval(), ioHandle::blockSize, libsshIoCommon::file, libsshIoCommon::handler, libsshIoCommon::path, libsshCommon::sftp, and copyRequest::vanished.

Here is the call graph for this function:

~readerLibssh()

inputHandler::libssh::readerLibssh::~readerLibssh ( )

override

Definition at line 73 of file inputHandlerLibssh.cpp.

                                      {
        if (file != nullptr) {
            if (isUnwinding()) {
                if (sftp_close(file) == SSH_ERROR) {
                    errMsg::emit(errMsg::level::debug, errMsg::location(),
                                 path, "close during unwind ",
                                 "sftp error ", sftp_get_error(handler.sftp),
                                 ", ssh error ", ssh_get_error(handler.session));
                }
                return;
            }
            throwcall::sftp::badval(sftp_close(file), SSH_ERROR, handler,
                                    "can't close ", path, " after reading");
        }
    }

References throwcall::sftp::badval(), errMsg::debug, and errMsg::emit().

Here is the call graph for this function:

Member Function Documentation

checkUnchangedness()

void inputHandler::libssh::readerLibssh::checkUnchangedness ( )

override

Definition at line 138 of file inputHandlerLibssh.cpp.

                                                {
        auto stat = throwcall::sftp::badval(sftp_fstat(file), nullptr, handler,
                                            "can't stat", path);
        genericSftpStat readFinalStat(*stat, handler.getVfsStat(path));
        sftp_attributes_free(stat);
        if (readFinalStat.size != readInitialStat.size) {
            throw delayAdvisingError("file size has changed (" +
                                     std::to_string(readInitialStat.size) +
                                     " -> " +
                                     std::to_string(readFinalStat.size) +
                                     ") during reading on " + path);
        }
 
        if (!readFinalStat.isSameMtimeAs(readInitialStat)) {
            throw delayAdvisingError("file " + path + " was modified (" +
                                     std::to_string(std::chrono::duration_cast<std::chrono::duration<double>>(readFinalStat.getMtime() - readInitialStat.getMtime()).count()) +
                                     "s different mtime) during reading");
        }
    }

References throwcall::sftp::badval(), genericStat::getMtime(), genericStat::isSameMtimeAs(), and genericStat::size.

Here is the call graph for this function:

readBlock()

bool inputHandler::libssh::readerLibssh::readBlock ( block &  b )

override

Definition at line 97 of file inputHandlerLibssh.cpp.

                                               {
        b.clear(totalBytesRead);
        bool lastblock = false;
 
        auto bytesToRead = b.max_size();
 
        while (b.size() + blockSize <= bytesToRead) {
            readRateLimit.wait();
            auto bytes_read = sftp_read(file, b.bufferAt(b.size()), blockSize);
            if (bytes_read < 0) {
                throwcall::sftp::good0(1, handler, "read failed on ", path);
            }
            readRateLimit.update(bytes_read);
            if (bytes_read == 0) {
                lastblock = true;
                if (totalBytesRead < readInitialStat.size) {
                    throw delayAdvisingError(path + " has shrunk while reading, (" +
                                             std::to_string(readInitialStat.size) +
                                             " -> " +
                                             std::to_string(totalBytesRead) +
                                             ")");
                }
                break;
            }
            totalBytesRead += bytes_read;
            if (totalBytesRead > readInitialStat.size) {
                throw delayAdvisingError(path + " has grown while reading, (" +
                                         std::to_string(readInitialStat.size) +
                                         " -> " +
                                         std::to_string(totalBytesRead) +
                                         ")");
            }
 
            b.bump_size(bytes_read);
        }
 
 
        return lastblock;
    }

References block::bufferAt(), block::bump_size(), block::clear(), throwcall::sftp::good0(), block::max_size(), readRateLimit, block::size(), throttle::watch::update(), and throttle::watch::wait().

Here is the call graph for this function:

seek()

void inputHandler::libssh::readerLibssh::seek ( size_t  pos )

override

Definition at line 92 of file inputHandlerLibssh.cpp.

                                            {
        throwcall::sftp::good0(sftp_seek64(file, pos), handler,
                               "can't seek ", path, " to ", pos);
    }

References throwcall::sftp::good0().

Here is the call graph for this function:

---

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

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