<!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.h 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.h</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.h</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">#ifndef __BARRY_CONNECT_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_CONNECT_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="iconv_8h.html" title="iconv wrapper class, and pluggable interface for records">iconv.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="pin_8h.html" title="class for device PIN notation">pin.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="probe_8h.html" title="USB Blackberry detection routines.">probe.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <string></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <memory></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="time_8h.html" title="Time related conversion routines.">time.h</a>></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">class </span>SocketRoutingQueue;
<a name="l00036"></a>00036 <span class="keyword">class </span>Controller;
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Mode {
<a name="l00038"></a>00038 <span class="keyword">class </span>Desktop;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">class </span>BXEXPORT Connector
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keyword">protected</span>:
<a name="l00044"></a>00044 std::string m_password;
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> m_needs_reconnect;
<a name="l00046"></a>00046 <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">Barry::IConverter</a> m_ic;
<a name="l00047"></a>00047 Barry::ProbeResult m_probe_result;
<a name="l00048"></a>00048 <span class="keywordtype">int</span> m_connect_count;
<a name="l00049"></a>00049 time_t m_last_disconnect;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">protected</span>:
<a name="l00052"></a>00052 <span class="comment">// helper functions</span>
<a name="l00053"></a>00053 <span class="keyword">static</span> Barry::ProbeResult FindDevice(Barry::Pin pin);
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// required overrides by derived classes</span>
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartConnect(<span class="keyword">const</span> <span class="keywordtype">char</span> *password) = 0;
<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RetryPassword(<span class="keyword">const</span> <span class="keywordtype">char</span> *password) = 0;
<a name="l00058"></a>00058 <span class="keyword">virtual</span> <span class="keywordtype">void</span> FinishConnect() = 0;
<a name="l00059"></a>00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoDisconnect() = 0;<span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> /// slightly different than IsConnected()... this returns true</span>
<a name="l00061"></a>00061 <span class="comment"> /// even if there is a partial connection in progress...</span>
<a name="l00062"></a>00062 <span class="comment"> /// i.e. this returns true if DoDisconnect() can be safely skipped</span>
<a name="l00063"></a>00063 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsDisconnected() = 0;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">public</span>:
<a name="l00066"></a>00066 Connector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> std::string &locale,
<a name="l00067"></a>00067 Barry::Pin pin = 0);
<a name="l00068"></a>00068 Connector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> std::string &locale,
<a name="l00069"></a>00069 <span class="keyword">const</span> Barry::ProbeResult &result);
<a name="l00070"></a>00070 <span class="keyword">virtual</span> ~Connector();
<a name="l00071"></a>00071
<a name="l00072"></a>00072 IConverter& GetIConverter() { <span class="keywordflow">return</span> m_ic; }
<a name="l00073"></a>00073 <span class="keyword">const</span> IConverter& GetIConverter()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_ic; }
<a name="l00074"></a>00074 Barry::ProbeResult& GetProbeResult() { <span class="keywordflow">return</span> m_probe_result; }
<a name="l00075"></a>00075 <span class="keyword">const</span> Barry::ProbeResult& GetProbeResult()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_probe_result; }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ClearPassword();
<a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetPassword(<span class="keyword">const</span> <span class="keywordtype">char</span> *password);
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /// Returns true if connected, false if user cancelled, throws</span>
<a name="l00081"></a>00081 <span class="comment"> /// Barry exception on error.</span>
<a name="l00082"></a>00082 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Connect();
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment"> /// Disconnects from the device</span>
<a name="l00085"></a>00085 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Disconnect();
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> /// Returns same as Connect(), but normally remembers the password</span>
<a name="l00088"></a>00088 <span class="comment"> /// and so avoids prompting the user if possible. Password prompts</span>
<a name="l00089"></a>00089 <span class="comment"> /// are still possible though, if you have called ClearPassword().</span>
<a name="l00090"></a>00090 <span class="comment"> ///</span>
<a name="l00091"></a>00091 <span class="comment"> /// It is valid to call Reconnect() without ever calling Connect(),</span>
<a name="l00092"></a>00092 <span class="comment"> /// since Reconnect() is simply a wrapper that handles retries.</span>
<a name="l00093"></a>00093 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Reconnect(<span class="keywordtype">int</span> total_tries = 2);
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /// Calls Reconnect() (and returns it's result) only if you have</span>
<a name="l00096"></a>00096 <span class="comment"> /// called RequireDirtyReconnect(). Otherwise, does nothing, but</span>
<a name="l00097"></a>00097 <span class="comment"> /// returns true.</span>
<a name="l00098"></a>00098 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReconnectForDirtyFlags();
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> /// Returns true if connected, false if not</span>
<a name="l00101"></a>00101 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsConnected() = 0;
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /// This function flags the Connector object so that a future</span>
<a name="l00104"></a>00104 <span class="comment"> /// call to ReconnectForDirtyFlags() will actually Reconnect().</span>
<a name="l00105"></a>00105 <span class="comment"> /// This is needed in cases where you are updating the device,</span>
<a name="l00106"></a>00106 <span class="comment"> /// and require that the dirty flags on the device itself are</span>
<a name="l00107"></a>00107 <span class="comment"> /// properly cleared and updated. In this case, you must call</span>
<a name="l00108"></a>00108 <span class="comment"> /// ReconnectForDirtyFlags() before Desktop::GetRecordStateTable().</span>
<a name="l00109"></a>00109 <span class="comment"> /// Disconnecting from the device, or reconnecting, clears the flag.</span>
<a name="l00110"></a>00110 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> RequireDirtyReconnect();
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">//</span>
<a name="l00113"></a>00113 <span class="comment">// Callbacks, overridden by the application</span>
<a name="l00114"></a>00114 <span class="comment">//</span>
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment"> /// App should prompt user for password, fill password_result with</span>
<a name="l00117"></a>00117 <span class="comment"> /// what he enters and then return true. Return false if user</span>
<a name="l00118"></a>00118 <span class="comment"> /// wishes to stop trying.</span>
<a name="l00119"></a>00119 <span class="comment"> ///</span>
<a name="l00120"></a>00120 <span class="comment"> /// This function is *not* called from inside a catch() routine,</span>
<a name="l00121"></a>00121 <span class="comment"> /// so it is safe to throw exceptions from it if you must.</span>
<a name="l00122"></a>00122 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> PasswordPrompt(<span class="keyword">const</span> <a class="code" href="classBarry_1_1BadPassword.html" title="A bad or unknown password when talking to the device.">Barry::BadPassword</a> &bp,
<a name="l00123"></a>00123 std::string &password_result) = 0;
<a name="l00124"></a>00124 };
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">class </span>BXEXPORT DesktopConnector : <span class="keyword">public</span> Connector
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128 Barry::SocketRoutingQueue *m_router;
<a name="l00129"></a>00129 std::auto_ptr<Barry::Controller> m_con;
<a name="l00130"></a>00130 std::auto_ptr<Mode::Desktop> m_desktop;
<a name="l00131"></a>00131 <span class="keywordtype">int</span> m_connect_timeout;
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keyword">protected</span>:
<a name="l00134"></a>00134 <span class="keyword">virtual</span> <span class="keywordtype">void</span> StartConnect(<span class="keyword">const</span> <span class="keywordtype">char</span> *password);
<a name="l00135"></a>00135 <span class="keyword">virtual</span> <span class="keywordtype">void</span> RetryPassword(<span class="keyword">const</span> <span class="keywordtype">char</span> *password);
<a name="l00136"></a>00136 <span class="keyword">virtual</span> <span class="keywordtype">void</span> FinishConnect();
<a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DoDisconnect();
<a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsDisconnected();
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keyword">public</span>:
<a name="l00141"></a>00141 <span class="comment">// Override the timeout due to a firmware issue... sometimes</span>
<a name="l00142"></a>00142 <span class="comment">// the firmware will hang during a Reconnect, and fail to</span>
<a name="l00143"></a>00143 <span class="comment">// respond to a Desktop::Open(). To work around this, we</span>
<a name="l00144"></a>00144 <span class="comment">// set the default timeout to 10 seconds so that we find this</span>
<a name="l00145"></a>00145 <span class="comment">// failure early enough to fix it within opensync's 30 second timeout.</span>
<a name="l00146"></a>00146 <span class="comment">// Then if we get such a timeout, we do the Reconnect again and</span>
<a name="l00147"></a>00147 <span class="comment">// hope for the best... this often fixes it.</span>
<a name="l00148"></a>00148 <span class="comment">//</span>
<a name="l00149"></a>00149 DesktopConnector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> std::string &locale,
<a name="l00150"></a>00150 Barry::Pin pin = 0, Barry::SocketRoutingQueue *router = 0,
<a name="l00151"></a>00151 <span class="keywordtype">int</span> connect_timeout = 10000);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 DesktopConnector(<span class="keyword">const</span> <span class="keywordtype">char</span> *password, <span class="keyword">const</span> std::string &locale,
<a name="l00154"></a>00154 <span class="keyword">const</span> Barry::ProbeResult &result,
<a name="l00155"></a>00155 Barry::SocketRoutingQueue *router = 0,
<a name="l00156"></a>00156 <span class="keywordtype">int</span> connect_timeout = 10000);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsConnected();
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> PasswordPrompt(<span class="keyword">const</span> <a class="code" href="classBarry_1_1BadPassword.html" title="A bad or unknown password when talking to the device.">Barry::BadPassword</a> &bp,
<a name="l00161"></a>00161 std::string &password_result)
<a name="l00162"></a>00162 {
<a name="l00163"></a>00163 <span class="comment">// default to only trying the existing password once</span>
<a name="l00164"></a>00164 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="comment">//</span>
<a name="l00168"></a>00168 <span class="comment">// Do not use these functions if IsConnected() returns false</span>
<a name="l00169"></a>00169 <span class="comment">//</span>
<a name="l00170"></a>00170
<a name="l00171"></a>00171 Controller& GetController() { <span class="keywordflow">return</span> *m_con; }
<a name="l00172"></a>00172 Mode::Desktop& GetDesktop() { <span class="keywordflow">return</span> *m_desktop; }
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="keyword">const</span> Controller& GetController()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *m_con; }
<a name="l00175"></a>00175 <span class="keyword">const</span> Mode::Desktop& GetDesktop()<span class="keyword"> const</span>{ <span class="keywordflow">return</span> *m_desktop; }
<a name="l00176"></a>00176 };
<a name="l00177"></a>00177
<a name="l00178"></a>00178 }
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="preprocessor">#endif</span>
<a name="l00181"></a>00181 <span class="preprocessor"></span>
</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>
