\hypertarget{classkdb_1_1tools_1_1Backends}{}\doxysection{kdb\+::tools\+::Backends Class Reference}
\label{classkdb_1_1tools_1_1Backends}\index{kdb::tools::Backends@{kdb::tools::Backends}}


Allows one to list backends.  




{\ttfamily \#include $<$backends.\+hpp$>$}

\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static Backend\+Info\+Vector \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}{get\+Backend\+Info}} (\mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}} mount\+Conf)
\begin{DoxyCompactList}\small\item\em give info about current mounted backends \end{DoxyCompactList}\item 
static \mbox{\hyperlink{structkdb_1_1tools_1_1BackendInfo}{Backend\+Info}} \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_a692f3f6b5f01ed2e497a6e093e1e2e90}{find\+Backend}} (std\+::string const \&backend, \mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}} mount\+Conf, bool verbose=false)
\begin{DoxyCompactList}\small\item\em Find a backend in the given name. \end{DoxyCompactList}\item 
static bool \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}{umount}} (std\+::string const \&backend, \mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}} \&mount\+Conf)
\begin{DoxyCompactList}\small\item\em Unmount a backend by given mount\+Path. \end{DoxyCompactList}\item 
static std\+::string \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_a76af9122c56426f4d0119e44719c7309}{get\+Base\+Path}} (std\+::string name)
\begin{DoxyCompactList}\small\item\em returns the base path of a mounted backend below system/elektra/mountpoints \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}\label{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}} 
static const char $\ast$ \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}{mountpoints\+Path}} = \char`\"{}system/elektra/mountpoints\char`\"{}
\begin{DoxyCompactList}\small\item\em Below this path is the mount\+Conf. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Allows one to list backends. 

\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classkdb_1_1tools_1_1Backends_a692f3f6b5f01ed2e497a6e093e1e2e90}\label{classkdb_1_1tools_1_1Backends_a692f3f6b5f01ed2e497a6e093e1e2e90}} 
\index{kdb::tools::Backends@{kdb::tools::Backends}!findBackend@{findBackend}}
\index{findBackend@{findBackend}!kdb::tools::Backends@{kdb::tools::Backends}}
\doxysubsubsection{\texorpdfstring{findBackend()}{findBackend()}}
{\footnotesize\ttfamily \mbox{\hyperlink{structkdb_1_1tools_1_1BackendInfo}{Backend\+Info}} kdb\+::tools\+::\+Backends\+::find\+Backend (\begin{DoxyParamCaption}\item[{std\+::string const \&}]{mount\+Path,  }\item[{\mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}}}]{mount\+Conf,  }\item[{bool}]{verbose = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Find a backend in the given name. 


\begin{DoxyParams}{Parameters}
{\em mount\+Path} & the given backend name to find\\
\hline
\end{DoxyParams}
For backwards compatibility old-\/style names containing \+\_\+ instead of escaped / are accepted if no modern-\/style mountpoint is found.


\begin{DoxyParams}{Parameters}
{\em mount\+Conf} & the configuration to search (should contain keys below mountpoints\+Path to find something)\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the found backend or an empty \mbox{\hyperlink{structkdb_1_1tools_1_1BackendInfo}{Backend\+Info}} if nothing found (with empty strings) 
\end{DoxyReturn}
\mbox{\Hypertarget{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}\label{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}} 
\index{kdb::tools::Backends@{kdb::tools::Backends}!getBackendInfo@{getBackendInfo}}
\index{getBackendInfo@{getBackendInfo}!kdb::tools::Backends@{kdb::tools::Backends}}
\doxysubsubsection{\texorpdfstring{getBackendInfo()}{getBackendInfo()}}
{\footnotesize\ttfamily Backends\+::\+Backend\+Info\+Vector kdb\+::tools\+::\+Backends\+::get\+Backend\+Info (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}}}]{mount\+Conf }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



give info about current mounted backends 


\begin{DoxyParams}{Parameters}
{\em mount\+Conf} & a keyset that contains everything below \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}{Backends\+::mountpoints\+Path}}\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
an vector of information about mounted backends 
\end{DoxyReturn}
\mbox{\Hypertarget{classkdb_1_1tools_1_1Backends_a76af9122c56426f4d0119e44719c7309}\label{classkdb_1_1tools_1_1Backends_a76af9122c56426f4d0119e44719c7309}} 
\index{kdb::tools::Backends@{kdb::tools::Backends}!getBasePath@{getBasePath}}
\index{getBasePath@{getBasePath}!kdb::tools::Backends@{kdb::tools::Backends}}
\doxysubsubsection{\texorpdfstring{getBasePath()}{getBasePath()}}
{\footnotesize\ttfamily std\+::string kdb\+::tools\+::\+Backends\+::get\+Base\+Path (\begin{DoxyParamCaption}\item[{std\+::string}]{mp }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



returns the base path of a mounted backend below system/elektra/mountpoints 


\begin{DoxyParams}{Parameters}
{\em mp} & the mountpoint (name will be derived from it)\\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the properly prefixed and escaped name 
\end{DoxyReturn}
\mbox{\Hypertarget{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}\label{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}} 
\index{kdb::tools::Backends@{kdb::tools::Backends}!umount@{umount}}
\index{umount@{umount}!kdb::tools::Backends@{kdb::tools::Backends}}
\doxysubsubsection{\texorpdfstring{umount()}{umount()}}
{\footnotesize\ttfamily bool kdb\+::tools\+::\+Backends\+::umount (\begin{DoxyParamCaption}\item[{std\+::string const \&}]{mount\+Path,  }\item[{\mbox{\hyperlink{classkdb_1_1KeySet}{Key\+Set}} \&}]{mount\+Conf }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Unmount a backend by given mount\+Path. 


\begin{DoxyParams}{Parameters}
{\em mount\+Path} & the given mountpoint\\
\hline
\end{DoxyParams}
Uses \mbox{\hyperlink{classkdb_1_1tools_1_1Backends_a692f3f6b5f01ed2e497a6e093e1e2e90}{find\+Backend()}} to locate the backend.


\begin{DoxyRetVals}{Return values}
{\em true} & if something was done \\
\hline
{\em false} & if nothing was done (but also no error) \\
\hline
\end{DoxyRetVals}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{backends_8hpp}{backends.\+hpp}}\item 
\mbox{\hyperlink{backends_8cpp}{backends.\+cpp}}\end{DoxyCompactItemize}
