<!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: connector.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>connector.cc</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// \file connector.cc</span>
<a name="l00003"></a>00003 <span class="comment">// Base class interface for handling Mode connections to device</span>
<a name="l00004"></a>00004 <span class="comment">//</span>
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 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 "connector.h"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="router_8h.html" title="Support classes for the pluggable socket routing system.">router.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="controller_8h.html" title="High level BlackBerry API class.">controller.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="m__desktop_8h.html" title="Mode class for the Desktop mode.">m_desktop.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "debug.h"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">using namespace </span>std;
<a name="l00029"></a>00029 <span class="keyword">using namespace </span>Barry;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry {
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00034"></a>00034 <span class="comment"></span><span class="comment">// Connector base class</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">// we use a const char *password here because we don't want the</span>
<a name="l00037"></a>00037 <span class="comment">// responsibility of clear its memory... that's the application's job</span>
<a name="l00038"></a>00038 Connector::Connector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password,
<a name="l00039"></a>00039 <span class="keyword">const</span> std::string &locale,
<a name="l00040"></a>00040 Barry::Pin pin)
<a name="l00041"></a>00041 : m_password(password)
<a name="l00042"></a>00042 , m_needs_reconnect(false)
<a name="l00043"></a>00043 , m_ic(locale.c_str())
<a name="l00044"></a>00044 , m_probe_result(FindDevice(pin))
<a name="l00045"></a>00045 , m_connect_count(0)
<a name="l00046"></a>00046 , m_last_disconnect(0)
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 }
<a name="l00049"></a>00049
<a name="l00050"></a>00050 Connector::Connector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password,
<a name="l00051"></a>00051 <span class="keyword">const</span> std::string &locale,
<a name="l00052"></a>00052 <span class="keyword">const</span> Barry::ProbeResult &result)
<a name="l00053"></a>00053 : m_password(password)
<a name="l00054"></a>00054 , m_needs_reconnect(false)
<a name="l00055"></a>00055 , m_ic(locale.c_str())
<a name="l00056"></a>00056 , m_probe_result(result)
<a name="l00057"></a>00057 , m_connect_count(0)
<a name="l00058"></a>00058 , m_last_disconnect(0)
<a name="l00059"></a>00059 {
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061
<a name="l00062"></a>00062 Connector::~Connector()
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 }
<a name="l00065"></a>00065
<a name="l00066"></a>00066 Barry::ProbeResult Connector::FindDevice(Barry::Pin pin)
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 Barry::Probe probe;
<a name="l00069"></a>00069 <span class="keywordtype">int</span> i = probe.FindActive(pin);
<a name="l00070"></a>00070 <span class="keywordflow">if</span>( i != -1 )
<a name="l00071"></a>00071 <span class="keywordflow">return</span> probe.Get(i);
<a name="l00072"></a>00072 <span class="keywordflow">else</span>
<a name="l00073"></a>00073 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1PinNotFound.html" title="Thrown by the Connector class when unable to find the requested Pin If the attached...">Barry::PinNotFound</a>(pin, probe.GetCount());
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordtype">void</span> Connector::ClearPassword()
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="comment">// blank the memory first</span>
<a name="l00079"></a>00079 <span class="keywordtype">size_t</span> len = m_password.size();
<a name="l00080"></a>00080 <span class="keywordflow">while</span>( len ) {
<a name="l00081"></a>00081 len--;
<a name="l00082"></a>00082 m_password[len] = <span class="charliteral">'0'</span>;
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// free it</span>
<a name="l00086"></a>00086 m_password.clear();
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keywordtype">void</span> Connector::SetPassword(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 ClearPassword();
<a name="l00092"></a>00092 m_password = password;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> Connector::Connect()
<a name="l00096"></a>00096 {
<a name="l00097"></a>00097 Disconnect();
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">bool</span> started = <span class="keyword">false</span>;
<a name="l00100"></a>00100 <a class="code" href="classBarry_1_1BadPassword.html" title="A bad or unknown password when talking to the device.">BadPassword</a> bpcopy(<span class="stringliteral">""</span>, 0, 0);
<a name="l00101"></a>00101 <span class="keywordflow">for</span>(;;) {
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keywordflow">try</span> {
<a name="l00104"></a>00104 <span class="keywordflow">if</span>( !started ) {
<a name="l00105"></a>00105 started = <span class="keyword">true</span>;
<a name="l00106"></a>00106 StartConnect(m_password.c_str());
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108 <span class="keywordflow">else</span> {
<a name="l00109"></a>00109 RetryPassword(m_password.c_str());
<a name="l00110"></a>00110 }
<a name="l00111"></a>00111
<a name="l00112"></a>00112 FinishConnect();
<a name="l00113"></a>00113 m_connect_count++;
<a name="l00114"></a>00114 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00115"></a>00115
<a name="l00116"></a>00116 }
<a name="l00117"></a>00117 <span class="keywordflow">catch</span>( <a class="code" href="classBarry_1_1BadPassword.html" title="A bad or unknown password when talking to the device.">BadPassword</a> &bp ) {
<a name="l00118"></a>00118 <span class="keywordflow">if</span>( bp.<a class="code" href="classBarry_1_1BadPassword.html#ef0225bf420465b818ad3d13f523fe9e">out_of_tries</a>() ) {
<a name="l00119"></a>00119 <span class="keywordflow">throw</span>;
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 bpcopy = bp;
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">// fall through to password prompt</span>
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">// ask user for device password</span>
<a name="l00128"></a>00128 ClearPassword();
<a name="l00129"></a>00129 <span class="keywordflow">if</span>( !PasswordPrompt(bpcopy, m_password) ) {
<a name="l00130"></a>00130 <span class="comment">// user wants out</span>
<a name="l00131"></a>00131 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00132"></a>00132 }
<a name="l00133"></a>00133 }
<a name="l00134"></a>00134 }
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keywordtype">void</span> Connector::Disconnect()
<a name="l00137"></a>00137 {
<a name="l00138"></a>00138 m_needs_reconnect = <span class="keyword">false</span>;
<a name="l00139"></a>00139 <span class="keywordflow">if</span>( !IsDisconnected() ) {
<a name="l00140"></a>00140 DoDisconnect();
<a name="l00141"></a>00141 m_last_disconnect = time(NULL);
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="keywordtype">bool</span> Connector::Reconnect(<span class="keywordtype">int</span> total_tries)
<a name="l00146"></a>00146 {
<a name="l00147"></a>00147 <span class="keywordtype">int</span> tries = 0;
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <span class="keywordflow">while</span>(1) <span class="keywordflow">try</span> {
<a name="l00150"></a>00150
<a name="l00151"></a>00151 tries++;
<a name="l00152"></a>00152
<a name="l00153"></a>00153 Disconnect();
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keywordflow">if</span>( m_connect_count ) {
<a name="l00156"></a>00156 <span class="comment">// let the device settle... this seems to help prevent</span>
<a name="l00157"></a>00157 <span class="comment">// the firmware hang, and therefore ultimately speeds</span>
<a name="l00158"></a>00158 <span class="comment">// up the sync</span>
<a name="l00159"></a>00159 <span class="keywordflow">if</span>( (time(NULL) - m_last_disconnect) < 2 ) {
<a name="l00160"></a>00160 <span class="comment">// don't bother sleeping if 2 seconds have</span>
<a name="l00161"></a>00161 <span class="comment">// already passed</span>
<a name="l00162"></a>00162 sleep(1);
<a name="l00163"></a>00163 }
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">// temporary fix for odd reconnect message...</span>
<a name="l00166"></a>00166 <span class="comment">// without this probe, the reconnect will often fail on</span>
<a name="l00167"></a>00167 <span class="comment">// newer Blackberries due to an unexpected close socket</span>
<a name="l00168"></a>00168 <span class="comment">// message.</span>
<a name="l00169"></a>00169 <span class="comment">//</span>
<a name="l00170"></a>00170 <span class="comment">// It is unclear if this is really a message from</span>
<a name="l00171"></a>00171 <span class="comment">// the device, but until then, we add this probe.</span>
<a name="l00172"></a>00172 m_probe_result = FindDevice(m_probe_result.m_pin);
<a name="l00173"></a>00173 }
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keywordflow">return</span> Connect();
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 <span class="keywordflow">catch</span>( Usb::Timeout & ) {
<a name="l00178"></a>00178 <span class="keywordflow">if</span>( tries >= total_tries ) {
<a name="l00179"></a>00179 <span class="keywordflow">throw</span>;
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181 <span class="keywordflow">else</span> {
<a name="l00182"></a>00182 dout(<span class="stringliteral">"Timeout in Connector::Reconnect()... trying again"</span>);
<a name="l00183"></a>00183 }
<a name="l00184"></a>00184 }
<a name="l00185"></a>00185 }
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keywordtype">bool</span> Connector::ReconnectForDirtyFlags()
<a name="l00188"></a>00188 {
<a name="l00189"></a>00189 <span class="keywordflow">if</span>( m_needs_reconnect ) {
<a name="l00190"></a>00190 <span class="keywordflow">return</span> Reconnect();
<a name="l00191"></a>00191 }
<a name="l00192"></a>00192 <span class="keywordflow">else</span> {
<a name="l00193"></a>00193 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196
<a name="l00197"></a>00197 <span class="keywordtype">void</span> Connector::RequireDirtyReconnect()
<a name="l00198"></a>00198 {
<a name="l00199"></a>00199 m_needs_reconnect = <span class="keyword">true</span>;
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00204"></a>00204 <span class="comment"></span><span class="comment">// DesktopConnector class</span>
<a name="l00205"></a>00205
<a name="l00206"></a>00206 DesktopConnector::DesktopConnector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password,
<a name="l00207"></a>00207 <span class="keyword">const</span> std::string &locale,
<a name="l00208"></a>00208 Barry::Pin pin,
<a name="l00209"></a>00209 Barry::SocketRoutingQueue *router,
<a name="l00210"></a>00210 <span class="keywordtype">int</span> connect_timeout)
<a name="l00211"></a>00211 : Connector(password, locale, pin)
<a name="l00212"></a>00212 , m_router(router)
<a name="l00213"></a>00213 , m_connect_timeout(connect_timeout)
<a name="l00214"></a>00214 {
<a name="l00215"></a>00215 }
<a name="l00216"></a>00216
<a name="l00217"></a>00217 DesktopConnector::DesktopConnector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password,
<a name="l00218"></a>00218 <span class="keyword">const</span> std::string &locale,
<a name="l00219"></a>00219 <span class="keyword">const</span> Barry::ProbeResult &result,
<a name="l00220"></a>00220 Barry::SocketRoutingQueue *router,
<a name="l00221"></a>00221 <span class="keywordtype">int</span> connect_timeout)
<a name="l00222"></a>00222 : Connector(password, locale, result)
<a name="l00223"></a>00223 , m_router(router)
<a name="l00224"></a>00224 , m_connect_timeout(connect_timeout)
<a name="l00225"></a>00225 {
<a name="l00226"></a>00226 }
<a name="l00227"></a>00227
<a name="l00228"></a>00228 <span class="keywordtype">void</span> DesktopConnector::StartConnect(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00229"></a>00229 {
<a name="l00230"></a>00230 <span class="comment">// Note that there is a firmware issue that causes the firmware</span>
<a name="l00231"></a>00231 <span class="comment">// to sometimes hang during a connect and it fails to respond</span>
<a name="l00232"></a>00232 <span class="comment">// to a Desktop::Open() call. To work around this, set the</span>
<a name="l00233"></a>00233 <span class="comment">// timeout to something lower than the usual 30 seconds.</span>
<a name="l00234"></a>00234 <span class="comment">// The default in DesktopConnector is 10 seconds, which should</span>
<a name="l00235"></a>00235 <span class="comment">// be fine.</span>
<a name="l00236"></a>00236 <span class="comment">//</span>
<a name="l00237"></a>00237 <span class="comment">// If this bug triggers, a Timeout exception will be thrown,</span>
<a name="l00238"></a>00238 <span class="comment">// which will be caught by the Reconnect() method, and Reconnect()</span>
<a name="l00239"></a>00239 <span class="comment">// will retry according to the total number of retries it is</span>
<a name="l00240"></a>00240 <span class="comment">// set to do.</span>
<a name="l00241"></a>00241 <span class="comment">//</span>
<a name="l00242"></a>00242 <span class="keywordflow">if</span>( m_router ) {
<a name="l00243"></a>00243 m_con.reset( <span class="keyword">new</span> <a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Barry::Controller</a>(m_probe_result,
<a name="l00244"></a>00244 *m_router, m_connect_timeout) );
<a name="l00245"></a>00245 }
<a name="l00246"></a>00246 <span class="keywordflow">else</span> {
<a name="l00247"></a>00247 m_con.reset( <span class="keyword">new</span> <a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Barry::Controller</a>(m_probe_result,
<a name="l00248"></a>00248 m_connect_timeout) );
<a name="l00249"></a>00249 }
<a name="l00250"></a>00250 m_desktop.reset( <span class="keyword">new</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Barry::Mode::Desktop</a>(*m_con, m_ic) );
<a name="l00251"></a>00251 m_desktop->Open(password);
<a name="l00252"></a>00252 }
<a name="l00253"></a>00253
<a name="l00254"></a>00254 <span class="keywordtype">void</span> DesktopConnector::RetryPassword(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00255"></a>00255 {
<a name="l00256"></a>00256 m_desktop->RetryPassword(password);
<a name="l00257"></a>00257 }
<a name="l00258"></a>00258
<a name="l00259"></a>00259 <span class="keywordtype">void</span> DesktopConnector::FinishConnect()
<a name="l00260"></a>00260 {
<a name="l00261"></a>00261 }
<a name="l00262"></a>00262
<a name="l00263"></a>00263 <span class="keywordtype">void</span> DesktopConnector::DoDisconnect()
<a name="l00264"></a>00264 {
<a name="l00265"></a>00265 m_desktop.reset();
<a name="l00266"></a>00266 m_con.reset();
<a name="l00267"></a>00267 }
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="keywordtype">bool</span> DesktopConnector::IsDisconnected()
<a name="l00270"></a>00270 {
<a name="l00271"></a>00271 <span class="comment">// return true if DoDisconnect can safely be skipped</span>
<a name="l00272"></a>00272 <span class="keywordflow">return</span> !m_con.get() && !m_desktop.get();
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="keywordtype">bool</span> DesktopConnector::IsConnected()
<a name="l00276"></a>00276 {
<a name="l00277"></a>00277 <span class="keywordflow">if</span>( m_con.get() && m_desktop.get() )
<a name="l00278"></a>00278 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00279"></a>00279 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281
<a name="l00282"></a>00282 }
<a name="l00283"></a>00283
</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>
