<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: m_mode_base.cc Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>m_mode_base.cc</h1><a href="m__mode__base_8cc.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file m_mode_base.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Base for mode classes</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="m__mode__base_8h.html" title="Base for mode classes.">m_mode_base.h</a>"</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Mode {
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00027"></a>00027 <span class="comment"></span><span class="comment">// Mode base class</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 Mode::Mode(Controller &con, <a class="code" href="classBarry_1_1Controller.html#8b40b5d7e285b39375d857e1cea6cb15" title="Handheld mode type.">Controller::ModeType</a> type)
<a name="l00030"></a>00030 : m_con(con)
<a name="l00031"></a>00031 , m_modetype(type)
<a name="l00032"></a>00032 , m_ModeSocket(0)
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034 }
<a name="l00035"></a>00035
<a name="l00036"></a>00036 Mode::~Mode()
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 }
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">//</span>
<a name="l00041"></a>00041 <span class="comment">// Open</span>
<a name="l00042"></a>00042 <span class="comment">//</span><span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/// Select device mode. This is required before using any other mode-based</span>
<a name="l00044"></a>00044 <span class="comment">/// operations, such as GetDBDB() and LoadDatabase().</span>
<a name="l00045"></a>00045 <span class="comment">///</span>
<a name="l00046"></a>00046 <span class="comment">/// This function opens a socket to the device for communicating in Desktop</span>
<a name="l00047"></a>00047 <span class="comment">/// mode. If the device requires it, specify the password with a const char*</span>
<a name="l00048"></a>00048 <span class="comment">/// string in password. The password will not be stored in memory</span>
<a name="l00049"></a>00049 <span class="comment">/// inside this class, only a hash will be generated from it. After</span>
<a name="l00050"></a>00050 <span class="comment">/// using the hash, the hash memory will be set to 0. The application</span>
<a name="l00051"></a>00051 <span class="comment">/// is responsible for safely handling the raw password data.</span>
<a name="l00052"></a>00052 <span class="comment">///</span>
<a name="l00053"></a>00053 <span class="comment">/// You can retry the password by catching Barry::BadPassword and</span>
<a name="l00054"></a>00054 <span class="comment">/// calling RetryPassword() with the new password.</span>
<a name="l00055"></a>00055 <span class="comment">///</span>
<a name="l00056"></a>00056 <span class="comment">/// \exception Barry::Error</span>
<a name="l00057"></a>00057 <span class="comment">/// Thrown on protocol error.</span>
<a name="l00058"></a>00058 <span class="comment">///</span>
<a name="l00059"></a>00059 <span class="comment">/// \exception std::logic_error()</span>
<a name="l00060"></a>00060 <span class="comment">/// Thrown if unsupported mode is requested, or if socket</span>
<a name="l00061"></a>00061 <span class="comment">/// already open.</span>
<a name="l00062"></a>00062 <span class="comment">///</span>
<a name="l00063"></a>00063 <span class="comment">/// \exception Barry::BadPassword</span>
<a name="l00064"></a>00064 <span class="comment">/// Thrown when password is invalid or if not enough retries</span>
<a name="l00065"></a>00065 <span class="comment">/// left in the device.</span>
<a name="l00066"></a>00066 <span class="comment">///</span>
<a name="l00067"></a><a class="code" href="classBarry_1_1Mode_1_1Mode.html#1110243f16be2b647ed9810da27abe11">00067</a> <span class="comment"></span><span class="keywordtype">void</span> Mode::Open(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <span class="keywordflow">if</span>( m_ModeSocket ) {
<a name="l00070"></a>00070 m_socket->Close();
<a name="l00071"></a>00071 m_socket.reset();
<a name="l00072"></a>00072 m_ModeSocket = 0;
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a>00075 m_ModeSocket = m_con.<a class="code" href="classBarry_1_1Controller.html#13ec1c4f03ed7bbff8f25ef2259b3836">SelectMode</a>(m_modetype);
<a name="l00076"></a>00076 <a class="code" href="classBarry_1_1Mode_1_1Mode.html#cc4f959c1a8473562219bd0a265b004c" title="Retry a failed password attempt from the first call to Open().">RetryPassword</a>(password);
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">//</span>
<a name="l00080"></a>00080 <span class="comment">// Open</span>
<a name="l00081"></a>00081 <span class="comment">//</span><span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">/// Select device mode. This is required before using any other mode-based</span>
<a name="l00083"></a>00083 <span class="comment">/// operations, such as GetDBDB() and LoadDatabase().</span>
<a name="l00084"></a>00084 <span class="comment">///</span>
<a name="l00085"></a>00085 <span class="comment">/// This function opens a socket to the device for communicating in Desktop</span>
<a name="l00086"></a>00086 <span class="comment">/// mode. If the device requires it, specify the password with a const char*</span>
<a name="l00087"></a>00087 <span class="comment">/// string in password. The password will not be stored in memory</span>
<a name="l00088"></a>00088 <span class="comment">/// inside this class, only a hash will be generated from it. After</span>
<a name="l00089"></a>00089 <span class="comment">/// using the hash, the hash memory will be set to 0. The application</span>
<a name="l00090"></a>00090 <span class="comment">/// is responsible for safely handling the raw password data.</span>
<a name="l00091"></a>00091 <span class="comment">///</span>
<a name="l00092"></a>00092 <span class="comment">/// It uses the provided name as the name for the socket used in this mode.</span>
<a name="l00093"></a>00093 <span class="comment">/// Usually this shouldn't be needed unless using the raw channel mode.</span>
<a name="l00094"></a>00094 <span class="comment">///</span>
<a name="l00095"></a>00095 <span class="comment">/// You can retry the password by catching Barry::BadPassword and</span>
<a name="l00096"></a>00096 <span class="comment">/// calling RetryPassword() with the new password.</span>
<a name="l00097"></a>00097 <span class="comment">///</span>
<a name="l00098"></a>00098 <span class="comment">/// \exception Barry::Error</span>
<a name="l00099"></a>00099 <span class="comment">/// Thrown on protocol error.</span>
<a name="l00100"></a>00100 <span class="comment">///</span>
<a name="l00101"></a>00101 <span class="comment">/// \exception std::logic_error()</span>
<a name="l00102"></a>00102 <span class="comment">/// Thrown if unsupported mode is requested, or if socket</span>
<a name="l00103"></a>00103 <span class="comment">/// already open.</span>
<a name="l00104"></a>00104 <span class="comment">///</span>
<a name="l00105"></a>00105 <span class="comment">/// \exception Barry::BadPassword</span>
<a name="l00106"></a>00106 <span class="comment">/// Thrown when password is invalid or if not enough retries</span>
<a name="l00107"></a>00107 <span class="comment">/// left in the device.</span>
<a name="l00108"></a>00108 <span class="comment">///</span>
<a name="l00109"></a><a class="code" href="classBarry_1_1Mode_1_1Mode.html#210ebafa97831da0cacac24bd01299ac">00109</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Mode.html#1110243f16be2b647ed9810da27abe11" title="Select device mode.">Mode::Open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> <span class="keywordtype">char</span> *name)
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 <span class="keywordflow">if</span>( m_ModeSocket ) {
<a name="l00112"></a>00112 m_socket->Close();
<a name="l00113"></a>00113 m_socket.reset();
<a name="l00114"></a>00114 m_ModeSocket = 0;
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 m_ModeSocket = m_con.<a class="code" href="classBarry_1_1Controller.html#13ec1c4f03ed7bbff8f25ef2259b3836">SelectMode</a>(m_modetype, name);
<a name="l00118"></a>00118 <a class="code" href="classBarry_1_1Mode_1_1Mode.html#cc4f959c1a8473562219bd0a265b004c" title="Retry a failed password attempt from the first call to Open().">RetryPassword</a>(password);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">//</span>
<a name="l00122"></a>00122 <span class="comment">// RetryPassword</span>
<a name="l00123"></a>00123 <span class="comment">//</span><span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment">/// Retry a failed password attempt from the first call to Open().</span>
<a name="l00125"></a>00125 <span class="comment">/// Only call this function in response to Barry::BadPassword exceptions</span>
<a name="l00126"></a>00126 <span class="comment">/// that are thrown from Open().</span>
<a name="l00127"></a>00127 <span class="comment">///</span>
<a name="l00128"></a>00128 <span class="comment">/// \exception Barry::Error</span>
<a name="l00129"></a>00129 <span class="comment">/// Thrown on protocol error.</span>
<a name="l00130"></a>00130 <span class="comment">///</span>
<a name="l00131"></a>00131 <span class="comment">/// \exception std::logic_error()</span>
<a name="l00132"></a>00132 <span class="comment">/// Thrown if in unsupported mode, or if socket already open.</span>
<a name="l00133"></a>00133 <span class="comment">///</span>
<a name="l00134"></a>00134 <span class="comment">/// \exception Barry::BadPassword</span>
<a name="l00135"></a>00135 <span class="comment">/// Thrown when password is invalid or if not enough retries</span>
<a name="l00136"></a>00136 <span class="comment">/// left in the device.</span>
<a name="l00137"></a>00137 <span class="comment">///</span>
<a name="l00138"></a><a class="code" href="classBarry_1_1Mode_1_1Mode.html#cc4f959c1a8473562219bd0a265b004c">00138</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Mode.html#cc4f959c1a8473562219bd0a265b004c" title="Retry a failed password attempt from the first call to Open().">Mode::RetryPassword</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 <span class="keywordflow">if</span>( m_socket.get() != 0 )
<a name="l00141"></a>00141 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Socket alreay open in RetryPassword"</span>);
<a name="l00142"></a>00142
<a name="l00143"></a>00143 m_socket = m_con.<a class="code" href="classBarry_1_1Controller.html#a130ca60f8946b8763a59a29daa3a6aa">m_zero</a>.Open(m_ModeSocket, password);
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// success... perform open-oriented setup</span>
<a name="l00146"></a>00146 OnOpen();
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keywordtype">void</span> Mode::OnOpen()
<a name="l00151"></a>00151 {
<a name="l00152"></a>00152 }
<a name="l00153"></a>00153
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">// FIXME - is this necessary? and if it is, wouldn't it be better</span>
<a name="l00156"></a>00156 <span class="comment">// in the m_jvmdebug mode class? I'm not convinced that applications</span>
<a name="l00157"></a>00157 <span class="comment">// should have to bother with socket-level details.</span>
<a name="l00158"></a>00158 <span class="comment">//void Mode::Close()</span>
<a name="l00159"></a>00159 <span class="comment">//{</span>
<a name="l00160"></a>00160 <span class="comment">// if( m_ModeSocket ) {</span>
<a name="l00161"></a>00161 <span class="comment">// m_socket->Close();</span>
<a name="l00162"></a>00162 <span class="comment">// m_socket.reset();</span>
<a name="l00163"></a>00163 <span class="comment">// m_ModeSocket = 0;</span>
<a name="l00164"></a>00164 <span class="comment">// }</span>
<a name="l00165"></a>00165 <span class="comment">//}</span>
<a name="l00166"></a>00166
<a name="l00167"></a>00167 }} <span class="comment">// namespace Barry::Mode</span>
<a name="l00168"></a>00168
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
