classdmtclientconfig.tex

This SDK allows to integrate a syncml stack in a C++ application on a variety of platforms. Current

\section{DMTClientConfig Class Reference}
\label{classDMTClientConfig}\index{DMTClientConfig@{DMTClientConfig}}
This class is an extension of \doxyref{SyncManagerConfig}{p.}{classSyncManagerConfig} that is DM tree aware; this means that configuration properties are read/stored from/to the DM tree.  


{\tt \#include $<$DMTClientConfig.h$>$}

Inheritance diagram for DMTClientConfig:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=75pt]{classDMTClientConfig__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for DMTClientConfig:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=80pt]{classDMTClientConfig__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\textbf{DMTClientConfig} (const char $\ast$root) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_0a015915d9ea57ad0c808c33987206b3}

\item 
{\bf SyncSourceConfig} $\ast$ \textbf{getSyncSourceConfig} (const char $\ast$name, BOOL refresh=FALSE) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_296b6adf21a846f110856a4872193633}

\item 
{\bf SyncSourceConfig} $\ast$ \textbf{getSyncSourceConfig} (unsigned int i, BOOL refresh=FALSE) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_845db63f1bbb16b3c5bdeb3e850a2b10}

\item 
virtual BOOL \textbf{read} () EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_a2a7938de6b3e84526f1e2e8f61916b2}

\item 
virtual BOOL \textbf{save} () EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_f0783f95a5de82c1fe26f56cd7c45772}

\item 
virtual BOOL {\bf open} () EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Opens the configuration backend associated with the root context. \item\end{CompactList}\item 
virtual ManagementNode $\ast$ {\bf getSyncMLNode} () EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Provides access to the \char`\"{}syncml\char`\"{} configuration node, can be used to read/write custom configuration options. \item\end{CompactList}\item 
virtual int {\bf getNumSources} () EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_7f88e28ecd7f39d7209c8c94bf536a40}

\begin{CompactList}\small\item\em Gets number of sync source configurations, -1 if not open. \item\end{CompactList}\item 
virtual ManagementNode $\ast$ {\bf getSyncSourceNode} (int index) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Get the specified sync source configuration. \item\end{CompactList}\item 
virtual ManagementNode $\ast$ {\bf getSyncSourceNode} (const char $\ast$name) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_d030d887887f114ac034190a7d8aa071}

\begin{CompactList}\small\item\em Get the specified sync source configuration by name. \item\end{CompactList}\item 
virtual void {\bf close} () EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Closes the configuration backend. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void \textbf{initialize} ()\label{classDMTClientConfig_72404ce088de8e2a16261a3c72c47962}

\item 
virtual BOOL \textbf{readAccessConfig} (ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_2c3af92e6f7af50e4d156c87332516bc}

\item 
virtual void \textbf{saveAccessConfig} (ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_bd14899df4eaad476dff8b499a076be2}

\item 
virtual BOOL \textbf{readDeviceConfig} (ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_854e3c4055f75c2352e38047377a1d24}

\item 
virtual void \textbf{saveDeviceConfig} (ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_a87761e12b2717b22c00e3f5d4afac7b}

\item 
virtual BOOL \textbf{readSourceConfig} (int i, ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_66e14579d1ce7bb3f5c36bbfbab452e5}

\item 
virtual void \textbf{saveSourceConfig} (int i, ManagementNode \&n) EXTRA\_\-SECTION\_\-01\label{classDMTClientConfig_5b460e33f9eba4f190e026d86b6d90dc}

\item 
virtual BOOL {\bf readAuthConfig} (ManagementNode \&syncMLNode, ManagementNode \&authNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Called by readAccessConfig() to save authentication settings. \item\end{CompactList}\item 
virtual void {\bf saveAuthConfig} (ManagementNode \&syncMLNode, ManagementNode \&authNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving the settings. \item\end{CompactList}\item 
virtual BOOL {\bf readConnConfig} (ManagementNode \&syncMLNode, ManagementNode \&connNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading connection information. \item\end{CompactList}\item 
virtual void {\bf saveConnConfig} (ManagementNode \&syncMLNode, ManagementNode \&connNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving connection information. \item\end{CompactList}\item 
virtual BOOL {\bf readExtAccessConfig} (ManagementNode \&syncMLNode, ManagementNode \&extNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading additional access information. \item\end{CompactList}\item 
virtual void {\bf saveExtAccessConfig} (ManagementNode \&syncMLNode, ManagementNode \&extNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving additional access information. \item\end{CompactList}\item 
virtual BOOL {\bf readDevInfoConfig} (ManagementNode \&syncMLNode, ManagementNode \&devInfoNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading device information. \item\end{CompactList}\item 
virtual void {\bf saveDevInfoConfig} (ManagementNode \&syncMLNode, ManagementNode \&devInfoNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving device information. \item\end{CompactList}\item 
virtual BOOL {\bf readDevDetailConfig} (ManagementNode \&syncMLNode, ManagementNode \&devDetailNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading additional device information. \item\end{CompactList}\item 
virtual void {\bf saveDevDetailConfig} (ManagementNode \&syncMLNode, ManagementNode \&devDetailNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving additional device information. \item\end{CompactList}\item 
virtual BOOL {\bf readExtDevConfig} (ManagementNode \&syncMLNode, ManagementNode \&extNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading some more additional device information. \item\end{CompactList}\item 
virtual void {\bf saveExtDevConfig} (ManagementNode \&syncMLNode, ManagementNode \&extNode) EXTRA\_\-SECTION\_\-01
\begin{CompactList}\small\item\em Same as readAccessConfig() for saving some more additional device information. \item\end{CompactList}\item 
virtual BOOL {\bf readSourceVars} (int i, ManagementNode \&sourcesNode, ManagementNode \&sourceNode)
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading variables that the library uses internally, like anchors. \item\end{CompactList}\item 
virtual void {\bf saveSourceVars} (int i, ManagementNode \&sourcesNode, ManagementNode \&sourceNode)
\begin{CompactList}\small\item\em Same as readAccessConfig() for saveing variables that the library uses internally, like anchors. \item\end{CompactList}\item 
virtual BOOL {\bf readSourceConfig} (int i, ManagementNode \&sourcesNode, ManagementNode \&sourceNode)
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading the normal properties of a sync source, i.e. \item\end{CompactList}\item 
virtual void {\bf saveSourceConfig} (int i, ManagementNode \&sourcesNode, ManagementNode \&sourceNode)
\begin{CompactList}\small\item\em Same as readAccessConfig() for reading the normal properties of a sync source, i.e. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
char $\ast$ \textbf{rootContext}\label{classDMTClientConfig_804a7a3c49bbb88b1b49a419ad4f54aa}

\item 
DMTree $\ast$ \textbf{dmt}\label{classDMTClientConfig_4f8e57a55f283213d889c34a1b65e608}

\item 
ManagementNode $\ast$ \textbf{syncMLNode}\label{classDMTClientConfig_1506b900c1a0c3066c01808f63753aef}

\item 
ManagementNode $\ast$ \textbf{sourcesNode}\label{classDMTClientConfig_5e2189facd1d1e8271dc8192e94b088e}

\end{CompactItemize}


\subsection{Detailed Description}
This class is an extension of \doxyref{SyncManagerConfig}{p.}{classSyncManagerConfig} that is DM tree aware; this means that configuration properties are read/stored from/to the DM tree. 

\begin{Desc}
\item[{\bf Todo}]describe the properties of the DM tree and how they are grouped into device info, additional device info, extended device info, etc. \end{Desc}




\subsection{Member Function Documentation}
\index{DMTClientConfig@{DMTClientConfig}!readAuthConfig@{readAuthConfig}}
\index{readAuthConfig@{readAuthConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readAuthConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em authNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_a79613f62105b84a4a9f98193b1ad9d4}


Called by readAccessConfig() to save authentication settings. 

The purpose of making this function virtual is that a derived class can override it and then to read the settings from a different than the default \char`\"{}spds/syncml/auth\char`\"{} node by calling the base function with a different {\em authNode\/} parameter or generate the settings in some other way.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em authNode}]the \char`\"{}spds/syncml/auth\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveAuthConfig@{saveAuthConfig}}
\index{saveAuthConfig@{saveAuthConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveAuthConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em authNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_df91db6207ef50a5566f3ff67d87a0bc}


Same as readAccessConfig() for saving the settings. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em authNode}]the \char`\"{}spds/syncml/auth\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readConnConfig@{readConnConfig}}
\index{readConnConfig@{readConnConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readConnConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em connNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_6055bf7e3c429014fccd1e0b6790fde5}


Same as readAccessConfig() for reading connection information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em connNode}]the \char`\"{}spds/syncml/conn\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!saveConnConfig@{saveConnConfig}}
\index{saveConnConfig@{saveConnConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void DMTClientConfig::saveConnConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em connNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_778109bc7c9d7cfca62112ca09e225a9}


Same as readAccessConfig() for saving connection information. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em syncMLNode}]the \char`\"{}spds/syncml\char`\"{} node \item[{\em connNode}]the \char`\"{}spds/syncml/conn\char`\"{} node \end{description}
\end{Desc}
\index{DMTClientConfig@{DMTClientConfig}!readExtAccessConfig@{readExtAccessConfig}}
\index{readExtAccessConfig@{readExtAccessConfig}!DMTClientConfig@{DMTClientConfig}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual BOOL DMTClientConfig::readExtAccessConfig (ManagementNode \& {\em syncMLNode}, ManagementNode \& {\em extNode})\hspace{0.3cm}{\tt  [protected, virtual]}}\label{classDMTClientConfig_83cfa2821328446f7e18cee6e4e7ebc6}


Same as readAccessConfig() for reading additional access information.