outputHandler::base Class Reference

#include <outputHandler.h>

Inheritance diagram for outputHandler::base:

Collaboration diagram for outputHandler::base:

Classes
class	factoryClass
	factory class to create outputHandler::base* objects More...
class	factoryTemplate
	template for factoryClass-derived factories More...
class	writer

Public Types
enum	renameRetvalType { renameRetvalType::ok, renameRetvalType::fileChanged, renameRetvalType::fileVanished, renameRetvalType::cantHappen }

Public Member Functions
	~base () override=default
virtual std::unique_ptr< writer >	newWriter (const std::string &path, bool mightAppend, size_t sourceSize, size_t readBlockSize, copyRequest::stateType &state, bool noWrite, std::unique_ptr< ioHandle::attrDataType > attrData, std::unique_ptr< acl::list > aclData)=0
virtual std::unique_ptr< writer >	newTmpWriter (std::string &path, size_t sourceSize, bool noWrite, std::unique_ptr< ioHandle::attrDataType > attrData, std::unique_ptr< acl::list > aclData)
virtual void	ensureParentDirs (const std::string &path, const std::string &srcPath, inputHandler::base *InputHandler)=0
virtual void	remove (const std::string &path, copyRequest::stateType &state)=0
virtual bool	renameSimple (const std::string &fromPath, const std::string &toPath)=0
virtual void	createSymlink (const std::vector< char > &, const std::string &, uid_t, gid_t)
virtual renameRetvalType	rename (const std::string &fromPath, const std::unique_ptr< const genericStat > &readInitialStat, const std::string &toPath, copyRequest::stateType &state)=0
virtual void	doAttributePreservations (const std::string &, const genericStat &)
virtual size_t	getMaxNameLength (const std::string &dirPath)
template<class C >
void	shortenNameToMax (const std::string &path, C &pathBuf, const std::string &suffix)
Public Member Functions inherited from pathHandler
virtual	~pathHandler ()=default
virtual bool	pathExists (const std::string &path)=0
virtual std::unique_ptr< const genericStat >	getStat (const std::string &path, bool followLink=true)=0
virtual std::string	getXattr (const std::string &, const std::string &)

Static Public Member Functions
static base *	newHandler (const std::string &name)
template<class T >
static void	addAllowedNamesToOption (T &option)

Protected Member Functions
	base ()=default

Static Protected Member Functions
static std::map< std::string, factoryClass * > &	getFactoryMap ()

Detailed Description

Definition at line 17 of file outputHandler.h.

Member Enumeration Documentation

renameRetvalType

enum outputHandler::base::renameRetvalType

strong

Enumerator
ok
fileChanged
fileVanished
cantHappen

Definition at line 106 of file outputHandler.h.

                                    {
            ok,
            fileChanged,
            fileVanished,
            cantHappen
        };

Constructor & Destructor Documentation

base()

outputHandler::base::base ( )

protecteddefault

~base()

outputHandler::base::~base ( )

overridedefault

Member Function Documentation

addAllowedNamesToOption()

template<class T >

static void outputHandler::base::addAllowedNamesToOption ( T &  option )

inlinestatic

Definition at line 87 of file outputHandler.h.

                                                                          {
            for (const auto& item : getFactoryMap()) {
                option.fAddToRange(item.first);
            }
        };

References getFactoryMap().

Here is the call graph for this function:

createSymlink()

virtual void outputHandler::base::createSymlink ( const std::vector< char > &  , const std::string &  , uid_t  , gid_t    )

inlinevirtual

Reimplemented in outputHandler::daosFs, outputHandler::posixFile, and outputHandler::libssh.

Definition at line 100 of file outputHandler.h.

                                                     {
            throw unimplementedActionError("symlink creation not implemented");
        }

doAttributePreservations()

virtual void outputHandler::base::doAttributePreservations ( const std::string &  , const genericStat &    )

inlinevirtual

Reimplemented in outputHandler::daosFs, outputHandler::posixFile, and outputHandler::dcap.

Definition at line 117 of file outputHandler.h.

                                                                    {
            throw unimplementedActionError("setMtime not implemented");
        }

ensureParentDirs()

virtual void outputHandler::base::ensureParentDirs ( const std::string &  path, const std::string &  srcPath, inputHandler::base *  InputHandler  )

pure virtual

Implemented in outputHandler::daosFs, outputHandler::posixFile, outputHandler::libssh, outputHandler::dcap, and outputHandler::davix.

getFactoryMap()

static std::map<std::string, factoryClass*>& outputHandler::base::getFactoryMap ( )

inlinestaticprotected

Definition at line 22 of file outputHandler.h.

                                                                 {
            static std::remove_reference<decltype(getFactoryMap())>::type map;
            return map;
        }

Referenced by addAllowedNamesToOption(), outputHandler::base::factoryClass::factoryClass(), and newHandler().

Here is the caller graph for this function:

getMaxNameLength()

size_t outputHandler::base::getMaxNameLength ( const std::string &  dirPath )

virtual

Reimplemented in outputHandler::daosFs, outputHandler::posixFile, and outputHandler::libssh.

Definition at line 34 of file outputHandler.cpp.

                                                    {
#ifdef NAME_MAX
        return NAME_MAX
#else
            return 255; // best guess for most cases
#endif
    }

Referenced by shortenNameToMax().

Here is the caller graph for this function:

newHandler()

static base* outputHandler::base::newHandler ( const std::string &  name )

inlinestatic

Definition at line 80 of file outputHandler.h.

                                                       {
            auto it = getFactoryMap().find(name);
            if (it != getFactoryMap().end()) {
                return it->second->create();
            }
            throw std::runtime_error("no outputHandler factory called " + name);
        }

References getFactoryMap().

Referenced by copyRequest::perThreadData::perThreadData().

Here is the call graph for this function:

Here is the caller graph for this function:

newTmpWriter()

std::unique_ptr< base::writer > outputHandler::base::newTmpWriter ( std::string &  path, size_t  sourceSize, bool  noWrite, std::unique_ptr< ioHandle::attrDataType >  attrData, std::unique_ptr< acl::list >  aclData  )

virtual

Reimplemented in outputHandler::Gpfs, outputHandler::daosFs, and outputHandler::posixFile.

Definition at line 9 of file outputHandler.cpp.

                                            {
        {
            std::string suffix(".");
            suffix += std::to_string(copyRequest::clock_type::now().time_since_epoch().count());
            suffix += std::to_string(getpid());
            suffix += ".tmp";
            shortenNameToMax(path,path,suffix);
            path += suffix;
        }
        copyRequest::stateType dummy;
        return newWriter(path, false, sourceSize, 0, dummy, noWrite,
                         std::move(attrData),
                         std::move(aclData));
    }

References newWriter(), and shortenNameToMax().

Here is the call graph for this function:

newWriter()

virtual std::unique_ptr<writer> outputHandler::base::newWriter ( const std::string &  path, bool  mightAppend, size_t  sourceSize, size_t  readBlockSize, copyRequest::stateType &  state, bool  noWrite, std::unique_ptr< ioHandle::attrDataType >  attrData, std::unique_ptr< acl::list >  aclData  )

pure virtual

Implemented in outputHandler::Gpfs, outputHandler::dcap, outputHandler::daosFs, outputHandler::posixFile, outputHandler::libssh, and outputHandler::davix.

Referenced by newTmpWriter().

Here is the caller graph for this function:

remove()

virtual void outputHandler::base::remove ( const std::string &  path, copyRequest::stateType &  state  )

pure virtual

Implemented in outputHandler::daosFs, outputHandler::posixFile, outputHandler::libssh, outputHandler::dcap, and outputHandler::davix.

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

Here is the caller graph for this function:

rename()

virtual renameRetvalType outputHandler::base::rename ( const std::string &  fromPath, const std::unique_ptr< const genericStat > &  readInitialStat, const std::string &  toPath, copyRequest::stateType &  state  )

pure virtual

Implemented in outputHandler::daosFs, outputHandler::posixFile, outputHandler::libssh, outputHandler::Gpfs, outputHandler::dcap, and outputHandler::davix.

renameSimple()

virtual bool outputHandler::base::renameSimple ( const std::string &  fromPath, const std::string &  toPath  )

pure virtual

Implemented in outputHandler::daosFs, outputHandler::posixFile, outputHandler::libssh, outputHandler::dcap, and outputHandler::davix.

shortenNameToMax()

template<class C >

void outputHandler::base::shortenNameToMax ( const std::string &  path, C &  pathBuf, const std::string &  suffix  )

inline

Definition at line 122 of file outputHandler.h.

                                                                          {
            auto lastSlash = path.find_last_of('/');
            std::string dirPath;
            size_t fileNameLength;
            if (lastSlash != std::string::npos) {
                fileNameLength = path.size() - lastSlash - 1;
                dirPath = path.substr(0,lastSlash);
            } else {
                fileNameLength = path.size();
                dirPath="./";
            }
            if (fileNameLength + suffix.size() > getMaxNameLength(dirPath)) {
                pathBuf.resize(path.size() - suffix.size());
            }
        }

References getMaxNameLength().

Referenced by newTmpWriter(), and outputHandler::posixFile::writerPosixFile::writerPosixFile().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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