\hypertarget{classkdb_1_1tools_1_1Backends}{\section{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$>$}

\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static Backend\+Info\+Vector \hyperlink{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}{get\+Backend\+Info} (\hyperlink{classkdb_1_1KeySet}{Key\+Set} mount\+Conf)
\begin{DoxyCompactList}\small\item\em give info about current mounted backends \end{DoxyCompactList}\item 
static \hyperlink{structkdb_1_1tools_1_1BackendInfo}{Backend\+Info} \hyperlink{classkdb_1_1tools_1_1Backends_a12ba74eaa70f5be9f39a1814dd61e85e}{find\+Backend} (std\+::string const \&backend, \hyperlink{classkdb_1_1KeySet}{Key\+Set} mount\+Conf)
\begin{DoxyCompactList}\small\item\em Find a backend in the given name. \end{DoxyCompactList}\item 
static bool \hyperlink{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}{umount} (std\+::string const \&backend, \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 \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}
\subsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}{static const char $\ast$ \hyperlink{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}{mountpoints\+Path} = \char`\"{}system/elektra/mountpoints\char`\"{}}\label{classkdb_1_1tools_1_1Backends_ac867850accaab4fda286f763cacc3926}

\begin{DoxyCompactList}\small\item\em Below this path is the mount\+Conf. \end{DoxyCompactList}\end{DoxyCompactItemize}


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

\subsection{Member Function Documentation}
\hypertarget{classkdb_1_1tools_1_1Backends_a12ba74eaa70f5be9f39a1814dd61e85e}{\index{kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}!find\+Backend@{find\+Backend}}
\index{find\+Backend@{find\+Backend}!kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}}
\subsubsection[{find\+Backend}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Backend\+Info} kdb\+::tools\+::\+Backends\+::find\+Backend (
\begin{DoxyParamCaption}
\item[{std\+::string const \&}]{mount\+Path, }
\item[{{\bf Key\+Set}}]{mount\+Conf}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classkdb_1_1tools_1_1Backends_a12ba74eaa70f5be9f39a1814dd61e85e}


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 \hyperlink{structkdb_1_1tools_1_1BackendInfo}{Backend\+Info} if nothing found (with empty strings) 
\end{DoxyReturn}
\hypertarget{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}{\index{kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}!get\+Backend\+Info@{get\+Backend\+Info}}
\index{get\+Backend\+Info@{get\+Backend\+Info}!kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}}
\subsubsection[{get\+Backend\+Info}]{\setlength{\rightskip}{0pt plus 5cm}Backends\+::\+Backend\+Info\+Vector kdb\+::tools\+::\+Backends\+::get\+Backend\+Info (
\begin{DoxyParamCaption}
\item[{{\bf Key\+Set}}]{mount\+Conf}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classkdb_1_1tools_1_1Backends_a82b334d8a1e01df664462c6dd43bd7e1}


give info about current mounted backends 


\begin{DoxyParams}{Parameters}
{\em mount\+Conf} & a keyset that contains everything below \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}
\hypertarget{classkdb_1_1tools_1_1Backends_a76af9122c56426f4d0119e44719c7309}{\index{kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}!get\+Base\+Path@{get\+Base\+Path}}
\index{get\+Base\+Path@{get\+Base\+Path}!kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}}
\subsubsection[{get\+Base\+Path}]{\setlength{\rightskip}{0pt plus 5cm}std\+::string kdb\+::tools\+::\+Backends\+::get\+Base\+Path (
\begin{DoxyParamCaption}
\item[{std\+::string}]{mp}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classkdb_1_1tools_1_1Backends_a76af9122c56426f4d0119e44719c7309}


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}
\hypertarget{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}{\index{kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}!umount@{umount}}
\index{umount@{umount}!kdb\+::tools\+::\+Backends@{kdb\+::tools\+::\+Backends}}
\subsubsection[{umount}]{\setlength{\rightskip}{0pt plus 5cm}bool kdb\+::tools\+::\+Backends\+::umount (
\begin{DoxyParamCaption}
\item[{std\+::string const \&}]{mount\+Path, }
\item[{{\bf Key\+Set} \&}]{mount\+Conf}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [static]}}}\label{classkdb_1_1tools_1_1Backends_aca36f903059e3df0f2ded569d6d8df8c}


Unmount a backend by given mount\+Path. 


\begin{DoxyParams}{Parameters}
{\em mount\+Path} & the given mountpoint\\
\hline
\end{DoxyParams}
Uses \hyperlink{classkdb_1_1tools_1_1Backends_a12ba74eaa70f5be9f39a1814dd61e85e}{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 
\hyperlink{backends_8hpp}{backends.\+hpp}\item 
backends.\+cpp\end{DoxyCompactItemize}
