<!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_desktop.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_desktop.cc</h1><a href="m__desktop_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_desktop.cc</span> <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Mode class for the Desktop mode</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__desktop_8h.html" title="Mode class for the Desktop mode.">m_desktop.h</a>"</span> <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span> <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span> <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span> <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="packet_8h.html" title="Low level protocol packet builder class.">packet.h</a>"</span> <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span> <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span> <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span> <a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="controller_8h.html" title="High level BlackBerry API class.">controller.h</a>"</span> <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="parser_8h.html" title="Virtual parser wrapper.">parser.h</a>"</span> <a name="l00032"></a>00032 <span class="preprocessor">#include <stdexcept></span> <a name="l00033"></a>00033 <span class="preprocessor">#include <sstream></span> <a name="l00034"></a>00034 <a name="l00035"></a>00035 <span class="preprocessor">#include "debug.h"</span> <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Mode { <a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="comment"></span> <a name="l00040"></a>00040 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span> <a name="l00041"></a>00041 <span class="comment"></span><span class="comment">// Desktop Mode class</span> <a name="l00042"></a>00042 <a name="l00043"></a>00043 Desktop::Desktop(Controller &con) <a name="l00044"></a>00044 : Mode(con, Controller::Desktop) <a name="l00045"></a>00045 , m_ic(0) <a name="l00046"></a>00046 { <a name="l00047"></a>00047 } <a name="l00048"></a>00048 <a name="l00049"></a>00049 Desktop::Desktop(Controller &con, <span class="keyword">const</span> IConverter &ic) <a name="l00050"></a>00050 : Mode(con, Controller::Desktop) <a name="l00051"></a>00051 , m_ic(&ic) <a name="l00052"></a>00052 { <a name="l00053"></a>00053 } <a name="l00054"></a>00054 <a name="l00055"></a>00055 Desktop::~Desktop() <a name="l00056"></a>00056 { <a name="l00057"></a>00057 } <a name="l00058"></a>00058 <span class="comment"></span> <a name="l00059"></a>00059 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span> <a name="l00060"></a>00060 <span class="comment"></span><span class="comment">// protected members</span> <a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="keywordtype">void</span> Desktop::LoadCommandTable() <a name="l00063"></a>00063 { <a name="l00064"></a>00064 <span class="keywordtype">char</span> rawCommand[] = { 6, 0, 0x0a, 0, 0x40, 0, 0, 1, 0, 0 }; <a name="l00065"></a>00065 *((uint16_t*) rawCommand) = htobs(m_socket->GetSocket()); <a name="l00066"></a>00066 <a name="l00067"></a>00067 Data command(rawCommand, <span class="keyword">sizeof</span>(rawCommand)); <a name="l00068"></a>00068 <a name="l00069"></a>00069 <span class="keywordflow">try</span> { <a name="l00070"></a>00070 m_socket->Packet(command, m_response); <a name="l00071"></a>00071 <a name="l00072"></a>00072 MAKE_PACKET(rpack, m_response); <a name="l00073"></a>00073 <span class="keywordflow">while</span>( rpack->command != SB_COMMAND_DB_DONE ) { <a name="l00074"></a>00074 m_socket->NextRecord(m_response); <a name="l00075"></a>00075 <a name="l00076"></a>00076 rpack = (<span class="keyword">const</span> Protocol::Packet *) m_response.GetData(); <a name="l00077"></a>00077 <span class="keywordflow">if</span>( rpack->command == SB_COMMAND_DB_DATA && btohs(rpack->size) > 10 ) { <a name="l00078"></a>00078 <span class="comment">// second packet is generally large, and contains</span> <a name="l00079"></a>00079 <span class="comment">// the command table</span> <a name="l00080"></a>00080 m_commandTable.Clear(); <a name="l00081"></a>00081 m_commandTable.Parse(m_response, 6); <a name="l00082"></a>00082 } <a name="l00083"></a>00083 } <a name="l00084"></a>00084 <a name="l00085"></a>00085 ddout(m_commandTable); <a name="l00086"></a>00086 <a name="l00087"></a>00087 } <a name="l00088"></a>00088 <span class="keywordflow">catch</span>( <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a> & ) { <a name="l00089"></a>00089 eout(<span class="stringliteral">"Desktop: error getting command table"</span>); <a name="l00090"></a>00090 eeout(command, m_response); <a name="l00091"></a>00091 <span class="keywordflow">throw</span>; <a name="l00092"></a>00092 } <a name="l00093"></a>00093 } <a name="l00094"></a>00094 <a name="l00095"></a>00095 <span class="keywordtype">void</span> Desktop::LoadDBDB() <a name="l00096"></a>00096 { <a name="l00097"></a>00097 DBPacket packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00098"></a>00098 packet.GetDBDB(); <a name="l00099"></a>00099 <a name="l00100"></a>00100 m_socket->Packet(packet); <a name="l00101"></a>00101 <a name="l00102"></a>00102 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00103"></a>00103 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_DB_DATA ) { <a name="l00104"></a>00104 m_dbdb.Clear(); <a name="l00105"></a>00105 m_dbdb.Parse(m_response); <a name="l00106"></a>00106 } <a name="l00107"></a>00107 <a name="l00108"></a>00108 <span class="comment">// advance!</span> <a name="l00109"></a>00109 m_socket->NextRecord(m_response); <a name="l00110"></a>00110 } <a name="l00111"></a>00111 } <a name="l00112"></a>00112 <a name="l00113"></a>00113 <span class="keywordtype">void</span> Desktop::OnOpen() <a name="l00114"></a>00114 { <a name="l00115"></a>00115 <span class="comment">// get command table and database database</span> <a name="l00116"></a>00116 LoadCommandTable(); <a name="l00117"></a>00117 LoadDBDB(); <a name="l00118"></a>00118 } <a name="l00119"></a>00119 <span class="comment"></span> <a name="l00120"></a>00120 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span> <a name="l00121"></a>00121 <span class="comment"></span><span class="comment">// public API</span> <a name="l00122"></a>00122 <a name="l00123"></a>00123 <span class="comment">//</span> <a name="l00124"></a>00124 <span class="comment">// GetDBID</span> <a name="l00125"></a>00125 <span class="comment">//</span><span class="comment"></span> <a name="l00126"></a>00126 <span class="comment">/// Get numeric database ID by name.</span> <a name="l00127"></a>00127 <span class="comment">///</span> <a name="l00128"></a>00128 <span class="comment">/// \param[in] name Name of database, which matches one of the</span> <a name="l00129"></a>00129 <span class="comment">/// names listed in GetDBDB()</span> <a name="l00130"></a>00130 <span class="comment">///</span> <a name="l00131"></a>00131 <span class="comment">/// \exception Barry::Error</span> <a name="l00132"></a>00132 <span class="comment">/// Thrown if name not found.</span> <a name="l00133"></a>00133 <span class="comment">///</span> <a name="l00134"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#4e1dad976351ad48029dc80d5f05fae3">00134</a> <span class="comment"></span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Desktop::GetDBID(<span class="keyword">const</span> std::string &name)<span class="keyword"> const</span> <a name="l00135"></a>00135 <span class="keyword"></span>{ <a name="l00136"></a>00136 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ID = 0; <a name="l00137"></a>00137 <span class="comment">// FIXME - this needs a better error handler...</span> <a name="l00138"></a>00138 <span class="keywordflow">if</span>( !m_dbdb.GetDBNumber(name, ID) ) { <a name="l00139"></a>00139 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"Desktop: database name not found: "</span> + name); <a name="l00140"></a>00140 } <a name="l00141"></a>00141 <span class="keywordflow">return</span> ID; <a name="l00142"></a>00142 } <a name="l00143"></a>00143 <a name="l00144"></a>00144 <span class="comment">//</span> <a name="l00145"></a>00145 <span class="comment">// GetDBCommand</span> <a name="l00146"></a>00146 <span class="comment">//</span><span class="comment"></span> <a name="l00147"></a>00147 <span class="comment">/// Get database command from command table. Must call Open()</span> <a name="l00148"></a>00148 <span class="comment">/// before this.</span> <a name="l00149"></a>00149 <span class="comment">///</span> <a name="l00150"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#b1d7a169122aae509924729aedfeb24f">00150</a> <span class="comment"></span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#b1d7a169122aae509924729aedfeb24f" title="Get database command from command table.">Desktop::GetDBCommand</a>(CommandType ct) <a name="l00151"></a>00151 { <a name="l00152"></a>00152 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> cmd = 0; <a name="l00153"></a>00153 <span class="keyword">const</span> <span class="keywordtype">char</span> *cmdName = <span class="stringliteral">"Unknown"</span>; <a name="l00154"></a>00154 <a name="l00155"></a>00155 <span class="keywordflow">switch</span>( ct ) <a name="l00156"></a>00156 { <a name="l00157"></a>00157 <span class="keywordflow">case</span> DatabaseAccess: <a name="l00158"></a>00158 cmdName = <span class="stringliteral">"Database Access"</span>; <a name="l00159"></a>00159 cmd = m_commandTable.GetCommand(cmdName); <a name="l00160"></a>00160 <span class="keywordflow">break</span>; <a name="l00161"></a>00161 <span class="keywordflow">default</span>: <a name="l00162"></a>00162 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Desktop: unknown command type"</span>); <a name="l00163"></a>00163 } <a name="l00164"></a>00164 <a name="l00165"></a>00165 <span class="keywordflow">if</span>( cmd == 0 ) { <a name="l00166"></a>00166 std::ostringstream oss; <a name="l00167"></a>00167 oss << <span class="stringliteral">"Desktop: unable to get command code: "</span> << cmdName; <a name="l00168"></a>00168 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00169"></a>00169 } <a name="l00170"></a>00170 <a name="l00171"></a>00171 <span class="keywordflow">return</span> cmd; <a name="l00172"></a>00172 } <a name="l00173"></a>00173 <a name="l00174"></a>00174 <span class="keywordtype">void</span> Desktop::SetIConverter(<span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> &ic) <a name="l00175"></a>00175 { <a name="l00176"></a>00176 m_ic = &ic; <a name="l00177"></a>00177 } <a name="l00178"></a>00178 <a name="l00179"></a>00179 <span class="comment">//</span> <a name="l00180"></a>00180 <span class="comment">// GetRecordStateTable</span> <a name="l00181"></a>00181 <span class="comment">//</span><span class="comment"></span> <a name="l00182"></a>00182 <span class="comment">/// Retrieve the record state table from the handheld device, using the given</span> <a name="l00183"></a>00183 <span class="comment">/// database ID. Results will be stored in result, which will be cleared</span> <a name="l00184"></a>00184 <span class="comment">/// before adding.</span> <a name="l00185"></a>00185 <span class="comment">///</span> <a name="l00186"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#047fe0a4a6dff740822451ffd38ddd84">00186</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#047fe0a4a6dff740822451ffd38ddd84" title="Retrieve the record state table from the handheld device, using the given database...">Desktop::GetRecordStateTable</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, RecordStateTable &result) <a name="l00187"></a>00187 { <a name="l00188"></a>00188 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00189"></a>00189 <a name="l00190"></a>00190 <span class="comment">// start fresh</span> <a name="l00191"></a>00191 result.Clear(); <a name="l00192"></a>00192 <a name="l00193"></a>00193 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00194"></a>00194 packet.<a class="code" href="classBarry_1_1DBPacket.html#07e2e8ca566a1f4d7cc493983b56c32b" title="Builds a command packet in the send buffer for the GET_RECORD_STATE_TABLE command...">GetRecordStateTable</a>(dbId); <a name="l00195"></a>00195 <a name="l00196"></a>00196 m_socket->Packet(packet); <a name="l00197"></a>00197 result.Parse(m_response); <a name="l00198"></a>00198 <a name="l00199"></a>00199 <span class="comment">// flush the command sequence</span> <a name="l00200"></a>00200 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) <a name="l00201"></a>00201 m_socket->NextRecord(m_response); <a name="l00202"></a>00202 } <a name="l00203"></a>00203 <a name="l00204"></a>00204 <span class="comment">//</span> <a name="l00205"></a>00205 <span class="comment">// AddRecord</span> <a name="l00206"></a>00206 <span class="comment">//</span><span class="comment"></span> <a name="l00207"></a>00207 <span class="comment">/// Adds a record to the specified database. RecordId is</span> <a name="l00208"></a>00208 <span class="comment">/// retrieved from build, and duplicate IDs are allowed by the device</span> <a name="l00209"></a>00209 <span class="comment">/// (i.e. you can have two records with the same ID)</span> <a name="l00210"></a>00210 <span class="comment">/// but *not* recommended!</span> <a name="l00211"></a>00211 <span class="comment"></span><span class="comment">//</span> <a name="l00212"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#0fec0d31ff496974acfc15fdc75f074a">00212</a> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#0fec0d31ff496974acfc15fdc75f074a" title="Adds a record to the specified database.">Desktop::AddRecord</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &build) <a name="l00213"></a>00213 { <a name="l00214"></a>00214 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00215"></a>00215 <a name="l00216"></a>00216 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00217"></a>00217 <a name="l00218"></a>00218 <span class="keywordflow">if</span>( packet.<a class="code" href="classBarry_1_1DBPacket.html#26c4025403d129f658c1919190c0a0f0" title="Builds a command packet in the m_send buffer for the SET_RECORD command code.">SetRecord</a>(dbId, build, m_ic) ) { <a name="l00219"></a>00219 <a name="l00220"></a>00220 std::ostringstream oss; <a name="l00221"></a>00221 <a name="l00222"></a>00222 m_socket->Packet(packet); <a name="l00223"></a>00223 <a name="l00224"></a>00224 <span class="comment">// successful packet transfer, so check the network return code</span> <a name="l00225"></a>00225 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00226"></a>00226 oss << <span class="stringliteral">"Desktop: device responded with unexpected packet command code: "</span> <a name="l00227"></a>00227 << <span class="stringliteral">"0x"</span> << std::hex << packet.Command(); <a name="l00228"></a>00228 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00229"></a>00229 } <a name="l00230"></a>00230 <a name="l00231"></a>00231 <span class="keywordflow">if</span>( packet.<a class="code" href="classBarry_1_1DBPacket.html#580e45267843fc6d43ca13c009e98978">ReturnCode</a>() != 0 ) { <a name="l00232"></a>00232 oss << <span class="stringliteral">"Desktop: device responded with error code (command: "</span> <a name="l00233"></a>00233 << packet.Command() << <span class="stringliteral">", code: "</span> <a name="l00234"></a>00234 << packet.<a class="code" href="classBarry_1_1DBPacket.html#580e45267843fc6d43ca13c009e98978">ReturnCode</a>() << <span class="stringliteral">")"</span>; <a name="l00235"></a>00235 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00236"></a>00236 } <a name="l00237"></a>00237 } <a name="l00238"></a>00238 } <a name="l00239"></a>00239 <a name="l00240"></a>00240 <span class="comment">//</span> <a name="l00241"></a>00241 <span class="comment">// GetRecord</span> <a name="l00242"></a>00242 <span class="comment">//</span><span class="comment"></span> <a name="l00243"></a>00243 <span class="comment">/// Retrieves a specific record from the specified database.</span> <a name="l00244"></a>00244 <span class="comment">/// The stateTableIndex comes from the GetRecordStateTable()</span> <a name="l00245"></a>00245 <span class="comment">/// function. GetRecord() does not clear the dirty flag.</span> <a name="l00246"></a>00246 <span class="comment">///</span> <a name="l00247"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#2420208d094c0195dd41b5836f54dc10">00247</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#2420208d094c0195dd41b5836f54dc10" title="Retrieves a specific record from the specified database.">Desktop::GetRecord</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a name="l00248"></a>00248 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, <a name="l00249"></a>00249 <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser) <a name="l00250"></a>00250 { <a name="l00251"></a>00251 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00252"></a>00252 <a name="l00253"></a>00253 std::string dbName; <a name="l00254"></a>00254 m_dbdb.GetDBName(dbId, dbName); <a name="l00255"></a>00255 <a name="l00256"></a>00256 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00257"></a>00257 packet.<a class="code" href="classBarry_1_1DBPacket.html#95355f6de0ab12e9eacd0727e8a66965" title="Builds a command packet in the send buffer for the GET_RECORD_BY_INDEX command code...">GetRecordByIndex</a>(dbId, stateTableIndex); <a name="l00258"></a>00258 <a name="l00259"></a>00259 m_socket->Packet(packet); <a name="l00260"></a>00260 <a name="l00261"></a>00261 <span class="comment">// perform copious packet checks</span> <a name="l00262"></a>00262 <span class="keywordflow">if</span>( m_response.GetSize() < SB_PACKET_RESPONSE_HEADER_SIZE ) { <a name="l00263"></a>00263 eeout(m_command, m_response); <a name="l00264"></a>00264 <a name="l00265"></a>00265 std::ostringstream oss; <a name="l00266"></a>00266 oss << <span class="stringliteral">"Desktop: invalid response packet size of "</span> <a name="l00267"></a>00267 << std::dec << m_response.GetSize(); <a name="l00268"></a>00268 eout(oss.str()); <a name="l00269"></a>00269 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00270"></a>00270 } <a name="l00271"></a>00271 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_DB_DATA ) { <a name="l00272"></a>00272 eeout(m_command, m_response); <a name="l00273"></a>00273 <a name="l00274"></a>00274 std::ostringstream oss; <a name="l00275"></a>00275 oss << <span class="stringliteral">"Desktop: unexpected command of 0x"</span> <a name="l00276"></a>00276 << std::setbase(16) << packet.Command() <a name="l00277"></a>00277 << <span class="stringliteral">" instead of expected 0x"</span> <a name="l00278"></a>00278 << std::setbase(16) << (<span class="keywordtype">unsigned</span> int)SB_COMMAND_DB_DATA; <a name="l00279"></a>00279 eout(oss.str()); <a name="l00280"></a>00280 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00281"></a>00281 } <a name="l00282"></a>00282 <a name="l00283"></a>00283 <span class="comment">// grab that data</span> <a name="l00284"></a>00284 packet.<a class="code" href="classBarry_1_1DBPacket.html#fd64b6c98e7ad1d482a8339e0283ff90" title="Parses the data in the receive buffer, and attempts to be smart about it, using the...">Parse</a>(parser, dbName, m_ic); <a name="l00285"></a>00285 <a name="l00286"></a>00286 <span class="comment">// flush the command sequence</span> <a name="l00287"></a>00287 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) <a name="l00288"></a>00288 m_socket->NextRecord(m_response); <a name="l00289"></a>00289 } <a name="l00290"></a>00290 <a name="l00291"></a>00291 <span class="comment">//</span> <a name="l00292"></a>00292 <span class="comment">// SetRecord</span> <a name="l00293"></a>00293 <span class="comment">//</span><span class="comment"></span> <a name="l00294"></a>00294 <span class="comment">/// Overwrites a specific record in the device as identified by the</span> <a name="l00295"></a>00295 <span class="comment">/// stateTableIndex.</span> <a name="l00296"></a>00296 <span class="comment">///</span> <a name="l00297"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#bf813b7fb04062515369209c8073dab0">00297</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#bf813b7fb04062515369209c8073dab0" title="Overwrites a specific record in the device as identified by the stateTableIndex.">Desktop::SetRecord</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, <a name="l00298"></a>00298 <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &build) <a name="l00299"></a>00299 { <a name="l00300"></a>00300 dout(<span class="stringliteral">"Database ID: "</span> << dbId << <span class="stringliteral">" Index: "</span> << stateTableIndex); <a name="l00301"></a>00301 <a name="l00302"></a>00302 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00303"></a>00303 <a name="l00304"></a>00304 <span class="comment">// write only if builder object has data</span> <a name="l00305"></a>00305 <span class="keywordflow">if</span>( !packet.<a class="code" href="classBarry_1_1DBPacket.html#7a41833dcc12c2823cd54991161e8d26" title="Builds a command packet in the m_send buffer for the SET_RECORD_BY_INDEX command...">SetRecordByIndex</a>(dbId, stateTableIndex, build, m_ic) ) { <a name="l00306"></a>00306 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Desktop: no data available in SetRecord"</span>); <a name="l00307"></a>00307 } <a name="l00308"></a>00308 <a name="l00309"></a>00309 m_socket->Packet(packet); <a name="l00310"></a>00310 <a name="l00311"></a>00311 std::ostringstream oss; <a name="l00312"></a>00312 <a name="l00313"></a>00313 <span class="comment">// successful packet transfer, so check the network return code</span> <a name="l00314"></a>00314 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00315"></a>00315 oss << <span class="stringliteral">"Desktop: device responded with unexpected packet command code: "</span> <a name="l00316"></a>00316 << <span class="stringliteral">"0x"</span> << std::hex << packet.Command(); <a name="l00317"></a>00317 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00318"></a>00318 } <a name="l00319"></a>00319 <a name="l00320"></a>00320 <span class="keywordflow">if</span>( packet.<a class="code" href="classBarry_1_1DBPacket.html#580e45267843fc6d43ca13c009e98978">ReturnCode</a>() != 0 ) { <a name="l00321"></a>00321 oss << <span class="stringliteral">"Desktop: device responded with error code (command: "</span> <a name="l00322"></a>00322 << packet.Command() << <span class="stringliteral">", code: "</span> <a name="l00323"></a>00323 << packet.<a class="code" href="classBarry_1_1DBPacket.html#580e45267843fc6d43ca13c009e98978">ReturnCode</a>() << <span class="stringliteral">")"</span>; <a name="l00324"></a>00324 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00325"></a>00325 } <a name="l00326"></a>00326 } <a name="l00327"></a>00327 <a name="l00328"></a>00328 <span class="comment">//</span> <a name="l00329"></a>00329 <span class="comment">// ClearDirty</span> <a name="l00330"></a>00330 <span class="comment">//</span><span class="comment"></span> <a name="l00331"></a>00331 <span class="comment">/// Clears the dirty flag on the specified record in the specified database.</span> <a name="l00332"></a>00332 <span class="comment">///</span> <a name="l00333"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#a766fb027d28f7cf4bb069eb0991baaa">00333</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#a766fb027d28f7cf4bb069eb0991baaa" title="Clears the dirty flag on the specified record in the specified database.">Desktop::ClearDirty</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex) <a name="l00334"></a>00334 { <a name="l00335"></a>00335 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00336"></a>00336 <a name="l00337"></a>00337 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00338"></a>00338 packet.<a class="code" href="classBarry_1_1DBPacket.html#9f0237393389b714f30bf56e616183dd" title="Builds a command packet in the send buffer for the SET_RECORD_FLAGS command code...">SetRecordFlags</a>(dbId, stateTableIndex, 0); <a name="l00339"></a>00339 <a name="l00340"></a>00340 m_socket->Packet(packet); <a name="l00341"></a>00341 <a name="l00342"></a>00342 <span class="comment">// flush the command sequence</span> <a name="l00343"></a>00343 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) <a name="l00344"></a>00344 m_socket->NextRecord(m_response); <a name="l00345"></a>00345 } <a name="l00346"></a>00346 <a name="l00347"></a>00347 <span class="comment">//</span> <a name="l00348"></a>00348 <span class="comment">// DeleteRecord</span> <a name="l00349"></a>00349 <span class="comment">//</span><span class="comment"></span> <a name="l00350"></a>00350 <span class="comment">/// Deletes the specified record in the specified database.</span> <a name="l00351"></a>00351 <span class="comment">///</span> <a name="l00352"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#04cd4063958483b31cc98a353f335fe0">00352</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#04cd4063958483b31cc98a353f335fe0" title="Deletes the specified record in the specified database.">Desktop::DeleteRecord</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex) <a name="l00353"></a>00353 { <a name="l00354"></a>00354 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00355"></a>00355 <a name="l00356"></a>00356 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00357"></a>00357 packet.<a class="code" href="classBarry_1_1DBPacket.html#fb9625f072f936a03ebee1ac64b78bf4" title="Builds a command packet in the send buffer for the DELETE_RECORD_BY_INDEX command...">DeleteRecordByIndex</a>(dbId, stateTableIndex); <a name="l00358"></a>00358 <a name="l00359"></a>00359 m_socket->Packet(packet); <a name="l00360"></a>00360 <a name="l00361"></a>00361 <span class="comment">// flush the command sequence</span> <a name="l00362"></a>00362 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) <a name="l00363"></a>00363 m_socket->NextRecord(m_response); <a name="l00364"></a>00364 } <a name="l00365"></a>00365 <a name="l00366"></a>00366 <span class="comment">//</span> <a name="l00367"></a>00367 <span class="comment">// LoadDatabase</span> <a name="l00368"></a>00368 <span class="comment">//</span><span class="comment"></span> <a name="l00369"></a>00369 <span class="comment">/// Retrieve a database from the handheld device, using the given parser</span> <a name="l00370"></a>00370 <span class="comment">/// to parse the resulting data, and optionally store it.</span> <a name="l00371"></a>00371 <span class="comment">///</span> <a name="l00372"></a>00372 <span class="comment">/// See the RecordParser<> template to create a parser object. The</span> <a name="l00373"></a>00373 <span class="comment">/// RecordParser<> template allows custom storage based on the type of</span> <a name="l00374"></a>00374 <span class="comment">/// database record retrieved. The database ID and the parser Record</span> <a name="l00375"></a>00375 <span class="comment">/// type must match.</span> <a name="l00376"></a>00376 <span class="comment">///</span> <a name="l00377"></a>00377 <span class="comment">/// \param[in] dbId Database Database ID - use GetDBID()</span> <a name="l00378"></a>00378 <span class="comment">/// \param[out] parser Parser object which parses the resulting</span> <a name="l00379"></a>00379 <span class="comment">/// protocol data, and optionally stores it in</span> <a name="l00380"></a>00380 <span class="comment">/// a custom fashion. See the RecordParser<></span> <a name="l00381"></a>00381 <span class="comment">/// template.</span> <a name="l00382"></a>00382 <span class="comment">///</span> <a name="l00383"></a>00383 <span class="comment">/// \exception Barry::Error</span> <a name="l00384"></a>00384 <span class="comment">/// Thrown on protocol error.</span> <a name="l00385"></a>00385 <span class="comment">///</span> <a name="l00386"></a>00386 <span class="comment">/// \exception std::logic_error</span> <a name="l00387"></a>00387 <span class="comment">/// Thrown if not in Desktop mode.</span> <a name="l00388"></a>00388 <span class="comment">///</span> <a name="l00389"></a><a class="code" href="classBarry_1_1Mode_1_1Desktop.html#6bb1c96d6082575b5fa684dee2af51a6">00389</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Mode_1_1Desktop.html#6bb1c96d6082575b5fa684dee2af51a6" title="Retrieve a database from the handheld device, using the given parser to parse the...">Desktop::LoadDatabase</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &parser) <a name="l00390"></a>00390 { <a name="l00391"></a>00391 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> data; <a name="l00392"></a>00392 <a class="code" href="classBarry_1_1Mode_1_1DBLoader.html" title="Database Loader operation class.">DBLoader</a> loader(*<span class="keyword">this</span>); <a name="l00393"></a>00393 <span class="keywordtype">bool</span> loading = loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#91865cdae00722a8c6fc53bcdf806a15">StartDBLoad</a>(dbId, data); <a name="l00394"></a>00394 <span class="keywordflow">while</span>( loading ) { <a name="l00395"></a>00395 <span class="comment">// manual parser call</span> <a name="l00396"></a>00396 parser.<a class="code" href="classBarry_1_1Parser.html#1d8325c74140cda51c5735c6f82b7511" title="Called to parse sub fields in the raw data packet.">ParseRecord</a>(data, m_ic); <a name="l00397"></a>00397 <a name="l00398"></a>00398 <span class="comment">// advance!</span> <a name="l00399"></a>00399 loading = loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#2f1152364ff8ea48e8735fe57fcaa15c">GetNextRecord</a>(data); <a name="l00400"></a>00400 } <a name="l00401"></a>00401 } <a name="l00402"></a>00402 <a name="l00403"></a>00403 <span class="keywordtype">void</span> Desktop::ClearDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId) <a name="l00404"></a>00404 { <a name="l00405"></a>00405 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00406"></a>00406 <a name="l00407"></a>00407 <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00408"></a>00408 packet.ClearDatabase(dbId); <a name="l00409"></a>00409 <a name="l00410"></a>00410 <span class="comment">// wait up to a minute here for old, slower devices with lots of data</span> <a name="l00411"></a>00411 m_socket->Packet(packet, 60000); <a name="l00412"></a>00412 <span class="keywordflow">if</span>( packet.ReturnCode() != 0 ) { <a name="l00413"></a>00413 std::ostringstream oss; <a name="l00414"></a>00414 oss << <span class="stringliteral">"Desktop: could not clear database: (command: "</span> <a name="l00415"></a>00415 << <span class="stringliteral">"0x"</span> << std::hex << packet.Command() << <span class="stringliteral">", code: "</span> <a name="l00416"></a>00416 << <span class="stringliteral">"0x"</span> << std::hex << packet.ReturnCode() << <span class="stringliteral">")"</span>; <a name="l00417"></a>00417 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(oss.str()); <a name="l00418"></a>00418 } <a name="l00419"></a>00419 <a name="l00420"></a>00420 <span class="comment">// check response to clear command was successful</span> <a name="l00421"></a>00421 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00422"></a>00422 eeout(m_command, m_response); <a name="l00423"></a>00423 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Error</a>(<span class="stringliteral">"Desktop: error clearing database, bad response"</span>); <a name="l00424"></a>00424 } <a name="l00425"></a>00425 } <a name="l00426"></a>00426 <a name="l00427"></a>00427 <span class="keywordtype">void</span> Desktop::SaveDatabase(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, Builder &builder) <a name="l00428"></a>00428 { <a name="l00429"></a>00429 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00430"></a>00430 <a name="l00431"></a>00431 <span class="comment">// Protocol note: so far in testing, this CLEAR_DATABASE operation is</span> <a name="l00432"></a>00432 <span class="comment">// required, since every record sent via SET_RECORD</span> <a name="l00433"></a>00433 <span class="comment">// is treated like a hypothetical "ADD_RECORD" (perhaps</span> <a name="l00434"></a>00434 <span class="comment">// SET_RECORD should be renamed)... I don't know if</span> <a name="l00435"></a>00435 <span class="comment">// there is a real SET_RECORD... all I know is from</span> <a name="l00436"></a>00436 <span class="comment">// the Windows USB captures, which uses this same</span> <a name="l00437"></a>00437 <span class="comment">// technique.</span> <a name="l00438"></a>00438 ClearDatabase(dbId); <a name="l00439"></a>00439 <a name="l00440"></a>00440 DBPacket packet(*<span class="keyword">this</span>, m_command, m_response); <a name="l00441"></a>00441 <a name="l00442"></a>00442 <span class="comment">// loop until builder object has no more data</span> <a name="l00443"></a>00443 <span class="keywordtype">bool</span> first = <span class="keyword">true</span>; <a name="l00444"></a>00444 <span class="keywordflow">while</span>( packet.SetRecord(dbId, builder, m_ic) ) { <a name="l00445"></a>00445 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00446"></a>00446 <a name="l00447"></a>00447 m_socket->Packet(packet, first ? 60000 : -1); <a name="l00448"></a>00448 first = <span class="keyword">false</span>; <a name="l00449"></a>00449 <a name="l00450"></a>00450 std::ostringstream oss; <a name="l00451"></a>00451 <span class="comment">// successful packet transfer, so check the network return code</span> <a name="l00452"></a>00452 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00453"></a>00453 oss << <span class="stringliteral">"Desktop: device responded with unexpected packet command code: "</span> <a name="l00454"></a>00454 << <span class="stringliteral">"0x"</span> << std::hex << packet.Command(); <a name="l00455"></a>00455 <span class="keywordflow">throw</span> Error(oss.str()); <a name="l00456"></a>00456 } <a name="l00457"></a>00457 <a name="l00458"></a>00458 <span class="keywordflow">if</span>( packet.ReturnCode() != 0 ) { <a name="l00459"></a>00459 oss << <span class="stringliteral">"Desktop: device responded with error code (command: "</span> <a name="l00460"></a>00460 << packet.Command() << <span class="stringliteral">", code: "</span> <a name="l00461"></a>00461 << packet.ReturnCode() << <span class="stringliteral">")"</span>; <a name="l00462"></a>00462 <span class="keywordflow">throw</span> Error(oss.str()); <a name="l00463"></a>00463 } <a name="l00464"></a>00464 } <a name="l00465"></a>00465 } <a name="l00466"></a>00466 <a name="l00467"></a>00467 <a name="l00468"></a>00468 <span class="comment"></span> <a name="l00469"></a>00469 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span> <a name="l00470"></a>00470 <span class="comment"></span><span class="comment">// DBLoader class</span> <a name="l00471"></a>00471 <a name="l00472"></a>00472 <span class="keyword">struct </span>DBLoaderData <a name="l00473"></a>00473 { <a name="l00474"></a>00474 DBPacket m_packet; <a name="l00475"></a>00475 DBLoaderData(Desktop &desktop, Data &command, Data &response) <a name="l00476"></a>00476 : m_packet(desktop, command, response) <a name="l00477"></a>00477 { <a name="l00478"></a>00478 } <a name="l00479"></a>00479 }; <a name="l00480"></a>00480 <a name="l00481"></a>00481 DBLoader::DBLoader(Desktop &desktop) <a name="l00482"></a>00482 : m_desktop(desktop) <a name="l00483"></a>00483 , m_loading(false) <a name="l00484"></a>00484 , m_loader(new DBLoaderData(desktop, m_send, m_send)) <a name="l00485"></a>00485 { <a name="l00486"></a>00486 } <a name="l00487"></a>00487 <a name="l00488"></a>00488 DBLoader::~DBLoader() <a name="l00489"></a>00489 { <a name="l00490"></a>00490 <span class="keyword">delete</span> m_loader; <a name="l00491"></a>00491 } <a name="l00492"></a>00492 <a name="l00493"></a>00493 <span class="keywordtype">bool</span> DBLoader::StartDBLoad(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, DBData &data) <a name="l00494"></a>00494 { <a name="l00495"></a>00495 dout(<span class="stringliteral">"Database ID: "</span> << dbId); <a name="l00496"></a>00496 <a name="l00497"></a>00497 m_loading = <span class="keyword">true</span>; <a name="l00498"></a>00498 m_desktop.m_dbdb.GetDBName(dbId, m_dbName); <a name="l00499"></a>00499 <a name="l00500"></a>00500 DBPacket &packet = m_loader->m_packet; <a name="l00501"></a>00501 packet.SetNewReceive(data.UseData()); <a name="l00502"></a>00502 packet.GetRecords(dbId); <a name="l00503"></a>00503 m_desktop.m_socket->Packet(packet); <a name="l00504"></a>00504 <a name="l00505"></a>00505 <span class="keywordflow">while</span>( packet.Command() != SB_COMMAND_DB_DONE ) { <a name="l00506"></a>00506 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_DB_DATA ) { <a name="l00507"></a>00507 packet.ParseMeta(data); <a name="l00508"></a>00508 data.SetDBName(m_dbName); <a name="l00509"></a>00509 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00510"></a>00510 } <a name="l00511"></a>00511 <a name="l00512"></a>00512 <span class="comment">// advance! (use the same data block as in packet)</span> <a name="l00513"></a>00513 m_desktop.m_socket->NextRecord(data.UseData()); <a name="l00514"></a>00514 } <a name="l00515"></a>00515 <a name="l00516"></a>00516 m_loading = <span class="keyword">false</span>; <a name="l00517"></a>00517 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00518"></a>00518 } <a name="l00519"></a>00519 <a name="l00520"></a>00520 <span class="keywordtype">bool</span> DBLoader::GetNextRecord(DBData &data) <a name="l00521"></a>00521 { <a name="l00522"></a>00522 <span class="keywordflow">if</span>( !m_loading ) <a name="l00523"></a>00523 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00524"></a>00524 <a name="l00525"></a>00525 DBPacket &packet = m_loader->m_packet; <a name="l00526"></a>00526 packet.SetNewReceive(data.UseData()); <a name="l00527"></a>00527 <a name="l00528"></a>00528 <span class="keywordflow">do</span> { <a name="l00529"></a>00529 <span class="comment">// advance! (use same data as in packet)</span> <a name="l00530"></a>00530 m_desktop.m_socket->NextRecord(data.UseData()); <a name="l00531"></a>00531 <a name="l00532"></a>00532 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_DB_DATA ) { <a name="l00533"></a>00533 packet.ParseMeta(data); <a name="l00534"></a>00534 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00535"></a>00535 } <a name="l00536"></a>00536 } <span class="keywordflow">while</span>( m_loader->m_packet.Command() != SB_COMMAND_DB_DONE ); <a name="l00537"></a>00537 <a name="l00538"></a>00538 m_loading = <span class="keyword">false</span>; <a name="l00539"></a>00539 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00540"></a>00540 } <a name="l00541"></a>00541 <a name="l00542"></a>00542 } <span class="comment">// namespace Barry::Mode</span> <a name="l00543"></a>00543 <a name="l00544"></a>00544 <a name="l00545"></a>00545 <a name="l00546"></a>00546 <a name="l00547"></a>00547 <span class="comment"></span> <a name="l00548"></a>00548 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span> <a name="l00549"></a>00549 <span class="comment"></span><span class="comment">// DeviceBuilder class</span> <a name="l00550"></a>00550 <a name="l00551"></a>00551 DeviceBuilder::DeviceBuilder(Mode::Desktop &desktop) <a name="l00552"></a>00552 : m_started(false) <a name="l00553"></a>00553 , m_desktop(desktop) <a name="l00554"></a>00554 , m_loader(desktop) <a name="l00555"></a>00555 { <a name="l00556"></a>00556 Restart(); <a name="l00557"></a>00557 } <a name="l00558"></a>00558 <a name="l00559"></a>00559 <span class="comment">// searches the dbdb from the desktop to find the dbId,</span> <a name="l00560"></a>00560 <span class="comment">// returns false if not found, and adds it to the list of</span> <a name="l00561"></a>00561 <span class="comment">// databases to retrieve if found</span> <a name="l00562"></a>00562 <span class="keywordtype">bool</span> DeviceBuilder::Add(<span class="keyword">const</span> std::string &dbname) <a name="l00563"></a>00563 { <a name="l00564"></a>00564 <span class="keywordflow">try</span> { <a name="l00565"></a>00565 DBLabel id(m_desktop.GetDBID(dbname), dbname); <a name="l00566"></a>00566 m_dbIds.push_back(<span class="keywordtype">id</span>); <a name="l00567"></a>00567 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00568"></a>00568 } <a name="l00569"></a>00569 <span class="keywordflow">catch</span>( <a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Barry::Error</a> & ) { <a name="l00570"></a>00570 <span class="comment">// GetDBID() throws on error...</span> <a name="l00571"></a>00571 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00572"></a>00572 } <a name="l00573"></a>00573 } <a name="l00574"></a>00574 <a name="l00575"></a>00575 <span class="keywordtype">void</span> DeviceBuilder::Add(<span class="keyword">const</span> Barry::DatabaseDatabase &dbdb) <a name="l00576"></a>00576 { <a name="l00577"></a>00577 DatabaseDatabase::DatabaseArrayType::const_iterator <a name="l00578"></a>00578 b = dbdb.Databases.begin(), <a name="l00579"></a>00579 e = dbdb.Databases.end(); <a name="l00580"></a>00580 <a name="l00581"></a>00581 <span class="keywordflow">for</span>( ; b != e; ++b ) { <a name="l00582"></a>00582 <span class="comment">// hmmm, could optimize this and only add ids</span> <a name="l00583"></a>00583 <span class="comment">// with RecordCount > 0, but let's stick with this</span> <a name="l00584"></a>00584 <span class="comment">// for now... it might flush bugs out of the system</span> <a name="l00585"></a>00585 DBLabel id(b->Number, b->Name); <a name="l00586"></a>00586 m_dbIds.push_back(<span class="keywordtype">id</span>); <a name="l00587"></a>00587 } <a name="l00588"></a>00588 } <a name="l00589"></a>00589 <a name="l00590"></a><a class="code" href="classBarry_1_1DeviceBuilder.html#292a7d4ee73590ce55c5d866739417ec">00590</a> <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DeviceBuilder.html#292a7d4ee73590ce55c5d866739417ec" title="Called to build the record field data.">DeviceBuilder::BuildRecord</a>(<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <a name="l00591"></a>00591 <span class="keywordtype">size_t</span> &offset, <a name="l00592"></a>00592 <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic) <a name="l00593"></a>00593 { <a name="l00594"></a>00594 <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> temp; <a name="l00595"></a>00595 <span class="keywordflow">if</span>( !<a class="code" href="classBarry_1_1DeviceBuilder.html#3eb2238b584aadac8af2f511cd2ba245" title="Same as BuildRecord, but does not care about any offsets.">FetchRecord</a>(temp, ic) ) <a name="l00596"></a>00596 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00597"></a>00597 <a name="l00598"></a>00598 <span class="comment">// copy the metadata</span> <a name="l00599"></a>00599 data.<a class="code" href="classBarry_1_1DBData.html#d1a3e69cabea68e0a309459cd7c58e78">SetVersion</a>(temp.<a class="code" href="classBarry_1_1DBData.html#b49877d999de648fd9fefca049686437">GetVersion</a>()); <a name="l00600"></a>00600 data.<a class="code" href="classBarry_1_1DBData.html#55d6bde680fe0b48d07882ade96ef9c3">SetDBName</a>(temp.<a class="code" href="classBarry_1_1DBData.html#37303ba0c4008a8afe0e5f09b823812e">GetDBName</a>()); <a name="l00601"></a>00601 data.<a class="code" href="classBarry_1_1DBData.html#a46147fced1b122cb6a0e6d1cee3cb07">SetIds</a>(temp.<a class="code" href="classBarry_1_1DBData.html#07523eb3b1dcfd99a917a184b61cb10a">GetRecType</a>(), temp.<a class="code" href="classBarry_1_1DBData.html#2a0106c7330842c455fc5393a3abfbc7">GetUniqueId</a>()); <a name="l00602"></a>00602 data.<a class="code" href="classBarry_1_1DBData.html#cb569139ee2d44442d4709ccf2a4ab3c">SetOffset</a>(offset); <a name="l00603"></a>00603 <a name="l00604"></a>00604 <span class="comment">// copy data from temp into the given offset</span> <a name="l00605"></a>00605 <span class="keywordtype">size_t</span> tempsize = temp.<a class="code" href="classBarry_1_1DBData.html#a7cacc9655376447ffbf3aa4d664a03b">GetData</a>().GetSize() - temp.<a class="code" href="classBarry_1_1DBData.html#5b301bfdcda5a74ccfd3f7e54fd69d99">GetOffset</a>(); <a name="l00606"></a>00606 data.<a class="code" href="classBarry_1_1DBData.html#3c1c4ad5ce85cef0ea85002a0fe07881">UseData</a>().MemCpy(offset, <a name="l00607"></a>00607 temp.<a class="code" href="classBarry_1_1DBData.html#a7cacc9655376447ffbf3aa4d664a03b">GetData</a>().GetData() + temp.<a class="code" href="classBarry_1_1DBData.html#5b301bfdcda5a74ccfd3f7e54fd69d99">GetOffset</a>(), tempsize); <a name="l00608"></a>00608 data.<a class="code" href="classBarry_1_1DBData.html#3c1c4ad5ce85cef0ea85002a0fe07881">UseData</a>().ReleaseBuffer(offset + tempsize); <a name="l00609"></a>00609 <span class="keywordflow">return</span> <span class="keyword">true</span>; <a name="l00610"></a>00610 } <a name="l00611"></a>00611 <a name="l00612"></a><a class="code" href="classBarry_1_1DeviceBuilder.html#3eb2238b584aadac8af2f511cd2ba245">00612</a> <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DeviceBuilder.html#3eb2238b584aadac8af2f511cd2ba245" title="Same as BuildRecord, but does not care about any offsets.">DeviceBuilder::FetchRecord</a>(<a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic) <a name="l00613"></a>00613 { <a name="l00614"></a>00614 <span class="keywordtype">bool</span> ret; <a name="l00615"></a>00615 <a name="l00616"></a>00616 <span class="keywordflow">if</span>( !m_dbIds.size() ) <a name="l00617"></a>00617 <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// nothing to do</span> <a name="l00618"></a>00618 <a name="l00619"></a>00619 <span class="keywordflow">if</span>( !m_started ) { <a name="l00620"></a>00620 m_current = m_dbIds.begin(); <a name="l00621"></a>00621 ret = m_loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#91865cdae00722a8c6fc53bcdf806a15">StartDBLoad</a>(m_current->id, data); <a name="l00622"></a>00622 m_started = <span class="keyword">true</span>; <a name="l00623"></a>00623 } <a name="l00624"></a>00624 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( m_loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#951ebb66ec127c4ee47ead54ac21dbca" title="Do not call Desktop members if this is true.">IsBusy</a>() ) { <a name="l00625"></a>00625 ret = m_loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#2f1152364ff8ea48e8735fe57fcaa15c">GetNextRecord</a>(data); <a name="l00626"></a>00626 } <a name="l00627"></a>00627 <span class="keywordflow">else</span> { <a name="l00628"></a>00628 <span class="comment">// don't do anything if we're at the end of our rope</span> <a name="l00629"></a>00629 <span class="keywordflow">if</span>( <a class="code" href="classBarry_1_1DeviceBuilder.html#7310e46f1fa8ee6e65f0717a656a4d5d" title="Sometimes a builder can have multiple databases stored in it, so when Build/Fetch...">EndOfFile</a>() ) <a name="l00630"></a>00630 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00631"></a>00631 <a name="l00632"></a>00632 <span class="comment">// advance and check again... m_current always points</span> <a name="l00633"></a>00633 <span class="comment">// to our current DB</span> <a name="l00634"></a>00634 ++m_current; <a name="l00635"></a>00635 <span class="keywordflow">if</span>( <a class="code" href="classBarry_1_1DeviceBuilder.html#7310e46f1fa8ee6e65f0717a656a4d5d" title="Sometimes a builder can have multiple databases stored in it, so when Build/Fetch...">EndOfFile</a>() ) <a name="l00636"></a>00636 <span class="keywordflow">return</span> <span class="keyword">false</span>; <a name="l00637"></a>00637 <a name="l00638"></a>00638 ret = m_loader.<a class="code" href="classBarry_1_1Mode_1_1DBLoader.html#91865cdae00722a8c6fc53bcdf806a15">StartDBLoad</a>(m_current->id, data); <a name="l00639"></a>00639 } <a name="l00640"></a>00640 <a name="l00641"></a>00641 <span class="comment">// fill in the DBname if successful</span> <a name="l00642"></a>00642 <span class="keywordflow">if</span>( ret ) { <a name="l00643"></a>00643 data.<a class="code" href="classBarry_1_1DBData.html#55d6bde680fe0b48d07882ade96ef9c3">SetDBName</a>(m_current->name); <a name="l00644"></a>00644 } <a name="l00645"></a>00645 <span class="keywordflow">return</span> ret; <a name="l00646"></a>00646 } <a name="l00647"></a>00647 <a name="l00648"></a><a class="code" href="classBarry_1_1DeviceBuilder.html#7310e46f1fa8ee6e65f0717a656a4d5d">00648</a> <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DeviceBuilder.html#7310e46f1fa8ee6e65f0717a656a4d5d" title="Sometimes a builder can have multiple databases stored in it, so when Build/Fetch...">DeviceBuilder::EndOfFile</a>()<span class="keyword"> const</span> <a name="l00649"></a>00649 <span class="keyword"></span>{ <a name="l00650"></a>00650 <span class="keywordflow">return</span> m_current == m_dbIds.end(); <a name="l00651"></a>00651 } <a name="l00652"></a>00652 <a name="l00653"></a>00653 <a name="l00654"></a>00654 <span class="comment"></span> <a name="l00655"></a>00655 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span> <a name="l00656"></a>00656 <span class="comment"></span><span class="comment">// DeviceParser class</span> <a name="l00657"></a>00657 <a name="l00658"></a>00658 DeviceParser::DeviceParser(<a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Mode::Desktop</a> &desktop, WriteMode mode) <a name="l00659"></a>00659 : m_desktop(desktop) <a name="l00660"></a>00660 , m_mode(mode) <a name="l00661"></a>00661 { <a name="l00662"></a>00662 } <a name="l00663"></a>00663 <a name="l00664"></a>00664 DeviceParser::~DeviceParser() <a name="l00665"></a>00665 { <a name="l00666"></a>00666 } <a name="l00667"></a>00667 <a name="l00668"></a>00668 <span class="keywordtype">void</span> DeviceParser::StartDB(<span class="keyword">const</span> DBData &data, <span class="keyword">const</span> IConverter *ic) <a name="l00669"></a>00669 { <a name="l00670"></a>00670 <span class="comment">// start fresh</span> <a name="l00671"></a>00671 m_rstate.Clear(); <a name="l00672"></a>00672 m_current_db = data.GetDBName(); <a name="l00673"></a>00673 <span class="keywordflow">if</span>( !m_desktop.GetDBDB().GetDBNumber(m_current_db, m_current_dbid) ) { <a name="l00674"></a>00674 <span class="comment">// doh! This database does not exist in this device</span> <a name="l00675"></a>00675 dout(<span class="stringliteral">"Database '"</span> << m_current_db << <span class="stringliteral">"' does not exist in this device. Dropping record."</span>); <a name="l00676"></a>00676 m_current_db.clear(); <a name="l00677"></a>00677 m_current_dbid = 0; <a name="l00678"></a>00678 <span class="keywordflow">return</span>; <a name="l00679"></a>00679 } <a name="l00680"></a>00680 <a name="l00681"></a>00681 <span class="comment">// determine mode</span> <a name="l00682"></a>00682 WriteMode mode = m_mode; <a name="l00683"></a>00683 <span class="keywordflow">if</span>( mode == DECIDE_BY_CALLBACK ) <a name="l00684"></a>00684 mode = DecideWrite(data); <a name="l00685"></a>00685 <a name="l00686"></a>00686 <span class="keywordflow">switch</span>( mode ) <a name="l00687"></a>00687 { <a name="l00688"></a>00688 <span class="keywordflow">case</span> ERASE_ALL_WRITE_ALL: <a name="l00689"></a>00689 m_desktop.ClearDatabase(m_current_dbid); <a name="l00690"></a>00690 WriteNext(data, ic); <a name="l00691"></a>00691 <span class="keywordflow">break</span>; <a name="l00692"></a>00692 <a name="l00693"></a>00693 <span class="keywordflow">case</span> INDIVIDUAL_OVERWRITE: <a name="l00694"></a>00694 <span class="keywordflow">case</span> ADD_BUT_NO_OVERWRITE: <a name="l00695"></a>00695 <span class="keywordflow">case</span> ADD_WITH_NEW_ID: <a name="l00696"></a>00696 m_desktop.GetRecordStateTable(m_current_dbid, m_rstate); <a name="l00697"></a>00697 WriteNext(data, ic); <a name="l00698"></a>00698 <span class="keywordflow">break</span>; <a name="l00699"></a>00699 <a name="l00700"></a>00700 <span class="keywordflow">case</span> DROP_RECORD: <a name="l00701"></a>00701 <span class="keywordflow">break</span>; <a name="l00702"></a>00702 <a name="l00703"></a>00703 <span class="keywordflow">case</span> DECIDE_BY_CALLBACK: <a name="l00704"></a>00704 <span class="keywordflow">default</span>: <a name="l00705"></a>00705 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"DeviceParser: unknown mode"</span>); <a name="l00706"></a>00706 } <a name="l00707"></a>00707 } <a name="l00708"></a>00708 <a name="l00709"></a>00709 <span class="keywordtype">void</span> DeviceParser::WriteNext(<span class="keyword">const</span> DBData &data, <span class="keyword">const</span> IConverter *ic) <a name="l00710"></a>00710 { <a name="l00711"></a>00711 <span class="comment">// determine mode</span> <a name="l00712"></a>00712 WriteMode mode = m_mode; <a name="l00713"></a>00713 <span class="keywordflow">if</span>( mode == DECIDE_BY_CALLBACK ) <a name="l00714"></a>00714 mode = DecideWrite(data); <a name="l00715"></a>00715 <a name="l00716"></a>00716 <span class="comment">// create fast copy with our own metadata</span> <a name="l00717"></a>00717 DBData local(data.GetVersion(), data.GetDBName(), <a name="l00718"></a>00718 data.GetRecType(), data.GetUniqueId(), data.GetOffset(), <a name="l00719"></a>00719 data.GetData().GetData(), data.GetData().GetSize()); <a name="l00720"></a>00720 DBDataBuilder dbuild(local); <a name="l00721"></a>00721 <a name="l00722"></a>00722 RecordStateTable::IndexType index; <a name="l00723"></a>00723 <a name="l00724"></a>00724 <span class="keywordflow">switch</span>( mode ) <a name="l00725"></a>00725 { <a name="l00726"></a>00726 <span class="keywordflow">case</span> ERASE_ALL_WRITE_ALL: <a name="l00727"></a>00727 <span class="comment">// just do an AddRecord()</span> <a name="l00728"></a>00728 m_desktop.AddRecord(m_current_dbid, dbuild); <a name="l00729"></a>00729 <span class="keywordflow">break</span>; <a name="l00730"></a>00730 <a name="l00731"></a>00731 <span class="keywordflow">case</span> INDIVIDUAL_OVERWRITE: <a name="l00732"></a>00732 <span class="comment">// search the state table, overwrite existing, and add new</span> <a name="l00733"></a>00733 <span class="keywordflow">if</span>( m_rstate.GetIndex(local.GetUniqueId(), &index) ) { <a name="l00734"></a>00734 <span class="comment">// found this record ID, use the index</span> <a name="l00735"></a>00735 m_desktop.SetRecord(m_current_dbid, index, dbuild); <a name="l00736"></a>00736 } <a name="l00737"></a>00737 <span class="keywordflow">else</span> { <a name="l00738"></a>00738 <span class="comment">// new record</span> <a name="l00739"></a>00739 m_desktop.AddRecord(m_current_dbid, dbuild); <a name="l00740"></a>00740 } <a name="l00741"></a>00741 <span class="keywordflow">break</span>; <a name="l00742"></a>00742 <a name="l00743"></a>00743 <span class="keywordflow">case</span> ADD_BUT_NO_OVERWRITE: <a name="l00744"></a>00744 <span class="keywordflow">if</span>( !m_rstate.GetIndex(local.GetUniqueId()) ) { <a name="l00745"></a>00745 <span class="comment">// no such record ID, so safe to add as new</span> <a name="l00746"></a>00746 m_desktop.AddRecord(m_current_dbid, dbuild); <a name="l00747"></a>00747 } <a name="l00748"></a>00748 <span class="comment">// else, drop record</span> <a name="l00749"></a>00749 <span class="keywordflow">break</span>; <a name="l00750"></a>00750 <a name="l00751"></a>00751 <span class="keywordflow">case</span> ADD_WITH_NEW_ID: <a name="l00752"></a>00752 <span class="comment">// use state table to create new id, and add as new</span> <a name="l00753"></a>00753 local.SetIds(local.GetRecType(), m_rstate.MakeNewRecordId()); <a name="l00754"></a>00754 m_desktop.AddRecord(m_current_dbid, dbuild); <a name="l00755"></a>00755 <span class="keywordflow">break</span>; <a name="l00756"></a>00756 <a name="l00757"></a>00757 <span class="keywordflow">case</span> DROP_RECORD: <a name="l00758"></a>00758 <span class="keywordflow">break</span>; <a name="l00759"></a>00759 <a name="l00760"></a>00760 <span class="keywordflow">case</span> DECIDE_BY_CALLBACK: <a name="l00761"></a>00761 <span class="keywordflow">default</span>: <a name="l00762"></a>00762 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"DeviceParser: unknown mode"</span>); <a name="l00763"></a>00763 } <a name="l00764"></a>00764 } <a name="l00765"></a>00765 <a name="l00766"></a><a class="code" href="classBarry_1_1DeviceParser.html#29558754a66d4f5c43c08af719a902c0">00766</a> <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DeviceParser.html#29558754a66d4f5c43c08af719a902c0" title="Parser overrides.">DeviceParser::ParseRecord</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> &data, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> *ic) <a name="l00767"></a>00767 { <a name="l00768"></a>00768 <span class="keywordflow">if</span>( data.<a class="code" href="classBarry_1_1DBData.html#37303ba0c4008a8afe0e5f09b823812e">GetDBName</a>() == m_current_db ) { <a name="l00769"></a>00769 WriteNext(data, ic); <a name="l00770"></a>00770 } <a name="l00771"></a>00771 <span class="keywordflow">else</span> { <a name="l00772"></a>00772 StartDB(data, ic); <a name="l00773"></a>00773 } <a name="l00774"></a>00774 } <a name="l00775"></a>00775 <a name="l00776"></a>00776 } <span class="comment">// namespace Barry</span> <a name="l00777"></a>00777 </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>