inputHandler::libssh Class Reference

#include <inputHandlerLibssh.h>

Inheritance diagram for inputHandler::libssh:

Collaboration diagram for inputHandler::libssh:

Classes
class	readerLibssh
class	SftpDirectory

Public Member Functions
	libssh ()
	~libssh () override=default
std::unique_ptr< reader >	newReader (const std::string &aPath, copyRequest::stateType &state, const genericStat &inititalStat) override
	get a reader for the file at path More...
bool	readLinkTarget (const std::string &path, std::vector< char > &target) override
	read link target from a symlink More...
std::unique_ptr< Directory >	getDirectory (const std::string &path) override
Public Member Functions inherited from inputHandler::base
virtual	~base () override=default
virtual std::unique_ptr< acl::list >	getAclData (const std::string &)
Public Member Functions inherited from pathHandler
virtual	~pathHandler ()=default
virtual std::string	getXattr (const std::string &, const std::string &)
Public Member Functions inherited from libsshCommon
void	reconnectSessions ()
template<typename T >
std::unique_ptr< T, void(*)(T *)>	getUniquePtr (T *obj, void(*deleter)(T *))
	libsshCommon (sshOptions &aOpt)
	~libsshCommon () override
bool	pathExists (const std::string &path) override
std::unique_ptr< const genericStat >	getStat (const std::string &path, bool followLink) override
const sftp_statvfs_struct &	getVfsStat (const std::string &path)

Static Private Attributes
static factoryTemplate< libssh >	factory

Additional Inherited Members
Static Public Member Functions inherited from inputHandler::base
static base *	newHandler (const std::string &name)
	create an instance of an inputHandler, select by name More...
template<class T >
static void	addAllowedNamesToOption (T &option)
Public Attributes inherited from libsshCommon
ssh_session	session
sftp_session	sftp
Protected Member Functions inherited from inputHandler::base
	base ()=default
Protected Member Functions inherited from libsshCommon
void	openSessions ()
void	closeSessions ()
Static Protected Member Functions inherited from inputHandler::base
static std::map< std::string, factoryClass * > &	getFactoryMap ()
Protected Attributes inherited from libsshCommon
sshOptions &	opt
bool	reconnecting

Detailed Description

Definition at line 14 of file inputHandlerLibssh.h.

Constructor & Destructor Documentation

libssh()

inputHandler::libssh::libssh

(

)

Definition at line 20 of file inputHandlerLibssh.cpp.

                  :
        libsshCommon(inputConfig) {
    }

~libssh()

inputHandler::libssh::~libssh ( )

overridedefault

Member Function Documentation

getDirectory()

std::unique_ptr< base::Directory > inputHandler::libssh::getDirectory ( const std::string &  path )

overridevirtual

Implements inputHandler::base.

Definition at line 194 of file inputHandlerLibssh.cpp.

                                                                           {
        return std::unique_ptr<Directory>(new SftpDirectory(*this, path));
    }

newReader()

std::unique_ptr< base::reader > inputHandler::libssh::newReader ( const std::string &  path, copyRequest::stateType &  state, const genericStat &  inititalStat  )

overridevirtual

get a reader for the file at path

Returns

unique ptr to a file reader.

Exceptions

std::system_error

if file can't be opened File will be closed when the pointer goes out of scope.

Parameters

[in]	path	[in] path to the file to be opened for reading
[in,out]	state	[in,out] state may be set to vanished if the file does not exist
[in]	inititalStat	[in] genericStat data of the file encountered before reading, needed for checking unchangedness at the end

Implements inputHandler::base.

Definition at line 24 of file inputHandlerLibssh.cpp.

                                             {
        return std::unique_ptr<base::reader>(new readerLibssh(aPath,
                                             *this,
                                             state,
                                             inititalStat));
    }

readLinkTarget()

bool inputHandler::libssh::readLinkTarget ( const std::string &  , std::vector< char > &    )

overridevirtual

read link target from a symlink

Parameters

[in]	path	is the path to the link
[in,out]	target	is a vector that the link target gets written into, must be large enough

Returns

true if link could be read, false if the link does not exist

Exceptions

std::system_error	if the link could not be read
std::runtime_error	if the target size is larger than target.size()

Reimplemented from inputHandler::base.

Definition at line 34 of file inputHandlerLibssh.cpp.

                                                         {
        auto targetString = sftp_readlink(sftp, path.c_str());
        if (targetString == nullptr && sftp_get_error(sftp) == SSH_FX_NO_SUCH_FILE) {
            return false;
        }
        throwcall::sftp::badval(targetString, nullptr, *this, "could not read link ", path);
        auto linklength = strlen(targetString);
        if (linklength >= target.size()) {
            ssh_string_free_char(targetString);
            throw std::runtime_error("link size increased after stat for " + path);
        }
        for (auto c = targetString; *c; c++) {
            target.at(c - targetString) = *c;
        }
        ssh_string_free_char(targetString);
        target[linklength] = '\0';
 
        return true;
    }

References throwcall::sftp::badval(), and libsshCommon::sftp.

Here is the call graph for this function:

Member Data Documentation

factory

factoryTemplate<libssh> inputHandler::libssh::factory

staticprivate

Definition at line 15 of file inputHandlerLibssh.h.

---

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)