NAME

       kdb::tools::Backends - Allows one to list backends.

SYNOPSIS

       #include <backends.hpp>

   Static Public Member Functions
       static BackendInfoVector getBackendInfo (KeySet mountConf)
           give info about current mounted backends
       static BackendInfo findBackend (std::string const &backend, KeySet mountConf, bool verbose=false)
           Find a backend in the given name.
       static bool umount (std::string const &backend, KeySet &mountConf)
           Unmount a backend by given mountPath.
       static std::string getBasePath (std::string name)
           returns the base path of a mounted backend below system/elektra/mountpoints

   Static Public Attributes
       static const char * mountpointsPath = 'system/elektra/mountpoints'
           Below this path is the mountConf.

Detailed Description

       Allows one to list backends.

Member Function Documentation

   BackendInfo kdb::tools::Backends::findBackend (std::string const & mountPath, KeySet mountConf, bool verbose
       = false) [static]
       Find a backend in the given name.

       Parameters:
           mountPath the given backend name to find

       For backwards compatibility old-style names containing _ instead of escaped / are accepted if no modern-
       style mountpoint is found.

       Parameters:
           mountConf the configuration to search (should contain keys below mountpointsPath to find something)

       Returns:
           the found backend or an empty BackendInfo if nothing found (with empty strings)

   Backends::BackendInfoVector kdb::tools::Backends::getBackendInfo (KeySet mountConf) [static]
       give info about current mounted backends

       Parameters:
           mountConf a keyset that contains everything below Backends::mountpointsPath

       Returns:
           an vector of information about mounted backends

   std::string kdb::tools::Backends::getBasePath (std::string mp) [static]
       returns the base path of a mounted backend below system/elektra/mountpoints

       Parameters:
           mp the mountpoint (name will be derived from it)

       Returns:
           the properly prefixed and escaped name

   bool kdb::tools::Backends::umount (std::string const & mountPath, KeySet & mountConf) [static]
       Unmount a backend by given mountPath.

       Parameters:
           mountPath the given mountpoint

       Uses findBackend() to locate the backend.

       Return values:
           true if something was done
           false if nothing was done (but also no error)

Author

       Generated automatically by Doxygen for Elektra from the source code.

Version 0.8.14                                   Tue Dec 15 2015                  kdb::tools::Backends(3elektra)