doc/www/doxygen/html/packet_8h-source.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: packet.h Source File</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>packet.h</h1><a href="packet_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       packet.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Low level protocol packet builder class.</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///             Has knowledge of specific protocol commands in order</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span><span class="comment">///             to hide protocol details behind an API.</span>
  28 <a name="l00006"></a>00006 <span class="comment"></span><span class="comment">///</span>
  29 <a name="l00007"></a>00007 <span class="comment"></span>
  30 <a name="l00008"></a>00008 <span class="comment">/*</span>
  31 <a name="l00009"></a>00009 <span class="comment">    Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
  32 <a name="l00010"></a>00010 <span class="comment"></span>
  33 <a name="l00011"></a>00011 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  34 <a name="l00012"></a>00012 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  35 <a name="l00013"></a>00013 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  36 <a name="l00014"></a>00014 <span class="comment">    (at your option) any later version.</span>
  37 <a name="l00015"></a>00015 <span class="comment"></span>
  38 <a name="l00016"></a>00016 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  39 <a name="l00017"></a>00017 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  40 <a name="l00018"></a>00018 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  41 <a name="l00019"></a>00019 <span class="comment"></span>
  42 <a name="l00020"></a>00020 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  43 <a name="l00021"></a>00021 <span class="comment">    root directory of this project for more details.</span>
  44 <a name="l00022"></a>00022 <span class="comment">*/</span>
  45 <a name="l00023"></a>00023
  46 <a name="l00024"></a>00024 <span class="preprocessor">#ifndef __BARRY_PACKET_H__</span>
  47 <a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PACKET_H__</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor"></span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;string&gt;</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span>
  52 <a name="l00030"></a>00030
  53 <a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry { <span class="keyword">class </span>Data; }
  54 <a name="l00032"></a>00032
  55 <a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
  56 <a name="l00034"></a>00034
  57 <a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
  58 <a name="l00036"></a>00036 <span class="keyword">class </span>Parser;
  59 <a name="l00037"></a>00037 <span class="keyword">class </span>Builder;
  60 <a name="l00038"></a>00038 <span class="keyword">class </span>SocketZero;
  61 <a name="l00039"></a>00039 <span class="keyword">class </span>Socket;
  62 <a name="l00040"></a>00040 <span class="keyword">class </span>IConverter;
  63 <a name="l00041"></a>00041 <span class="keyword">namespace </span>Mode {
  64 <a name="l00042"></a>00042         <span class="keyword">class </span>Desktop;
  65 <a name="l00043"></a>00043         <span class="keyword">class </span>JavaLoader;
  66 <a name="l00044"></a>00044 }
  67 <a name="l00045"></a>00045
  68 <a name="l00046"></a>00046 <span class="keyword">class </span>Packet
  69 <a name="l00047"></a>00047 {
  70 <a name="l00048"></a>00048         <span class="keyword">friend</span> <span class="keyword">class </span>SocketZero;
  71 <a name="l00049"></a>00049         <span class="keyword">friend</span> <span class="keyword">class </span>Socket;
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051 <span class="keyword">protected</span>:
  74 <a name="l00052"></a>00052         Data &amp;m_send, &amp;m_receive;
  75 <a name="l00053"></a>00053
  76 <a name="l00054"></a>00054         Data&amp; GetSend() { <span class="keywordflow">return</span> m_send; }
  77 <a name="l00055"></a>00055         Data&amp; GetReceive() { <span class="keywordflow">return</span> m_receive; }
  78 <a name="l00056"></a>00056
  79 <a name="l00057"></a>00057 <span class="keyword">public</span>:
  80 <a name="l00058"></a>00058         Packet(Data &amp;send, Data &amp;receive)
  81 <a name="l00059"></a>00059                 : m_send(send), m_receive(receive)
  82 <a name="l00060"></a>00060                 {}
  83 <a name="l00061"></a>00061         <span class="keyword">virtual</span> ~Packet() {}
  84 <a name="l00062"></a>00062 <span class="comment"></span>
  85 <a name="l00063"></a>00063 <span class="comment">        //////////////////////////////////</span>
  86 <a name="l00064"></a>00064 <span class="comment"></span>        <span class="comment">// common response analysis</span>
  87 <a name="l00065"></a>00065
  88 <a name="l00066"></a>00066         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Command() <span class="keyword">const</span>;   <span class="comment">// throws Error if receive isn't big enough</span>
  89 <a name="l00067"></a>00067 };
  90 <a name="l00068"></a>00068
  91 <a name="l00069"></a>00069 <span class="comment">//</span>
  92 <a name="l00070"></a>00070 <span class="comment">// ZeroPacket class</span>
  93 <a name="l00071"></a>00071 <span class="comment">//</span><span class="comment"></span>
  94 <a name="l00072"></a>00072 <span class="comment">/// Provides an API for building and analyzing socket-0 protocol packets.</span>
  95 <a name="l00073"></a>00073 <span class="comment">/// This class relies on 2 external objects: a send and receive Data buffer.</span>
  96 <a name="l00074"></a>00074 <span class="comment">///</span>
  97 <a name="l00075"></a>00075 <span class="comment">/// Note that the receive buffer may be modified</span>
  98 <a name="l00076"></a>00076 <span class="comment">/// during a packet send, and this class provides API helpers</span>
  99 <a name="l00077"></a>00077 <span class="comment">/// to analyze the results.</span>
 100 <a name="l00078"></a>00078 <span class="comment">///</span>
 101 <a name="l00079"></a><a class="code" href="classBarry_1_1ZeroPacket.html">00079</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classBarry_1_1ZeroPacket.html" title="Provides an API for building and analyzing socket-0 protocol packets.">ZeroPacket</a> : <span class="keyword">public</span> Packet
 102 <a name="l00080"></a>00080 {
 103 <a name="l00081"></a>00081         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &amp;quot;logical socket&amp;quot; in the Blackberry USB protocol.">Socket</a>;
 104 <a name="l00082"></a>00082
 105 <a name="l00083"></a>00083 <span class="keyword">public</span>:
 106 <a name="l00084"></a>00084         <a class="code" href="classBarry_1_1ZeroPacket.html" title="Provides an API for building and analyzing socket-0 protocol packets.">ZeroPacket</a>(Data &amp;send, Data &amp;receive);
 107 <a name="l00085"></a>00085         ~<a class="code" href="classBarry_1_1ZeroPacket.html" title="Provides an API for building and analyzing socket-0 protocol packets.">ZeroPacket</a>();
 108 <a name="l00086"></a>00086 <span class="comment"></span>
 109 <a name="l00087"></a>00087 <span class="comment">        //////////////////////////////////</span>
 110 <a name="l00088"></a>00088 <span class="comment"></span>        <span class="comment">// meta access</span>
 111 <a name="l00089"></a>00089 <span class="comment"></span>
 112 <a name="l00090"></a>00090 <span class="comment">        //////////////////////////////////</span>
 113 <a name="l00091"></a>00091 <span class="comment"></span>        <span class="comment">// packet building</span>
 114 <a name="l00092"></a>00092
 115 <a name="l00093"></a>00093         <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1ZeroPacket.html#7737431baba17201d588f1dba4c8bbe0" title="Builds a command packet for the initial socket-0 handshakes that fetch certain (some...">GetAttribute</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">object</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> attribute);
 116 <a name="l00094"></a>00094         <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1ZeroPacket.html#274fb9e330544f188df45f03ebe9180a" title="Builds command packet for sending echo request.">Echo</a>(uint64_t us_ticks);
 117 <a name="l00095"></a>00095         <span class="keywordtype">void</span> Reset();
 118 <a name="l00096"></a>00096
 119 <a name="l00097"></a>00097 <span class="comment"></span>
 120 <a name="l00098"></a>00098 <span class="comment">        //////////////////////////////////</span>
 121 <a name="l00099"></a>00099 <span class="comment"></span>        <span class="comment">// response analysis</span>
 122 <a name="l00100"></a>00100
 123 <a name="l00101"></a>00101         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ObjectID() <span class="keyword">const</span>;
 124 <a name="l00102"></a>00102         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> AttributeID() <span class="keyword">const</span>;
 125 <a name="l00103"></a>00103         uint32_t ChallengeSeed() <span class="keyword">const</span>;
 126 <a name="l00104"></a>00104         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RemainingTries() <span class="keyword">const</span>;
 127 <a name="l00105"></a>00105         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SocketResponse() <span class="keyword">const</span>;
 128 <a name="l00106"></a>00106         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> SocketSequence() <span class="keyword">const</span>;
 129 <a name="l00107"></a>00107         uint8_t CommandResponse() <span class="keyword">const</span>;
 130 <a name="l00108"></a>00108 };
 131 <a name="l00109"></a>00109
 132 <a name="l00110"></a>00110
 133 <a name="l00111"></a>00111 <span class="comment">//</span>
 134 <a name="l00112"></a>00112 <span class="comment">// DBPacket class</span>
 135 <a name="l00113"></a>00113 <span class="comment">//</span><span class="comment"></span>
 136 <a name="l00114"></a>00114 <span class="comment">/// Provides an API for building and analyzing raw DB protocol packets.</span>
 137 <a name="l00115"></a>00115 <span class="comment">/// This class relies on 3 external objects: a Mode::Desktop object,</span>
 138 <a name="l00116"></a>00116 <span class="comment">/// a send Data buffer, and a receive data buffer.  Socket and</span>
 139 <a name="l00117"></a>00117 <span class="comment">/// connection details are retrieved on a readonly basis from the</span>
 140 <a name="l00118"></a>00118 <span class="comment">/// Mode::Desktop object, but both send and receive buffers can be</span>
 141 <a name="l00119"></a>00119 <span class="comment">/// modified.</span>
 142 <a name="l00120"></a>00120 <span class="comment">///</span>
 143 <a name="l00121"></a>00121 <span class="comment">/// Note that the receive buffer may be modified</span>
 144 <a name="l00122"></a>00122 <span class="comment">/// during a packet send, and this DBPacket class provides API helpers</span>
 145 <a name="l00123"></a>00123 <span class="comment">/// to analyze the results.</span>
 146 <a name="l00124"></a>00124 <span class="comment">///</span>
 147 <a name="l00125"></a><a class="code" href="classBarry_1_1DBPacket.html">00125</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a> : <span class="keyword">public</span> Packet
 148 <a name="l00126"></a>00126 {
 149 <a name="l00127"></a>00127         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &amp;quot;logical socket&amp;quot; in the Blackberry USB protocol.">Socket</a>;
 150 <a name="l00128"></a>00128
 151 <a name="l00129"></a>00129 <span class="keyword">private</span>:
 152 <a name="l00130"></a>00130         <a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Mode::Desktop</a> &amp;m_con;
 153 <a name="l00131"></a>00131         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_last_dbop;       <span class="comment">// last database operation</span>
 154 <a name="l00132"></a>00132
 155 <a name="l00133"></a>00133 <span class="keyword">protected</span>:
 156 <a name="l00134"></a>00134
 157 <a name="l00135"></a>00135 <span class="keyword">public</span>:
 158 <a name="l00136"></a>00136         <a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a>(<a class="code" href="classBarry_1_1Mode_1_1Desktop.html" title="The main interface class to the device databases.">Mode::Desktop</a> &amp;con, Data &amp;send, Data &amp;receive);
 159 <a name="l00137"></a>00137         ~<a class="code" href="classBarry_1_1DBPacket.html" title="Provides an API for building and analyzing raw DB protocol packets.">DBPacket</a>();
 160 <a name="l00138"></a>00138 <span class="comment"></span>
 161 <a name="l00139"></a>00139 <span class="comment">        //////////////////////////////////</span>
 162 <a name="l00140"></a>00140 <span class="comment"></span>        <span class="comment">// meta access</span>
 163 <a name="l00141"></a>00141 <span class="comment"></span>
 164 <a name="l00142"></a>00142 <span class="comment">        //////////////////////////////////</span>
 165 <a name="l00143"></a>00143 <span class="comment"></span>        <span class="comment">// packet building</span>
 166 <a name="l00144"></a>00144
 167 <a name="l00145"></a>00145         <span class="comment">// commands that correspond to the DB operation</span>
 168 <a name="l00146"></a>00146         <span class="comment">// constants in protocol.h</span>
 169 <a name="l00147"></a>00147         <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#ace85c6dd63c5f85e21e9f61e10e5af5" title="Builds a command packet for the CLEAR_DATABASE command code, placing the data in...">ClearDatabase</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId);
 170 <a name="l00148"></a>00148         <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#206e98e5159e7fe7790d4976d0f039a0" title="Builds a command packet for the GET_DBDB command code, placing the data in m_send...">GetDBDB</a>();
 171 <a name="l00149"></a>00149         <span class="keywordtype">void</span> <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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId);
 172 <a name="l00150"></a>00150         <span class="keywordtype">void</span> <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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, uint8_t flag1);
 173 <a name="l00151"></a>00151         <span class="keywordtype">void</span> <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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex);
 174 <a name="l00152"></a>00152         <span class="keywordtype">void</span> <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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex);
 175 <a name="l00153"></a>00153         <span class="keywordtype">bool</span> <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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stateTableIndex, <a class="code" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> &amp;build, <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);
 176 <a name="l00154"></a>00154         <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#173b8eb90186edc54e8a679d7498bcb5" title="Builds a command packet in the send buffer for the GET_RECORDS command code.">GetRecords</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> dbId);
 177 <a name="l00155"></a>00155         <span class="keywordtype">bool</span> <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>(<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> &amp;build, <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);
 178 <a name="l00156"></a>00156
 179 <a name="l00157"></a>00157 <span class="comment"></span>
 180 <a name="l00158"></a>00158 <span class="comment">        //////////////////////////////////</span>
 181 <a name="l00159"></a>00159 <span class="comment"></span>        <span class="comment">// response analysis</span>
 182 <a name="l00160"></a>00160
 183 <a name="l00161"></a>00161         <span class="comment">// DB command response functions</span>
 184 <a name="l00162"></a>00162         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ReturnCode() <span class="keyword">const</span>;        <span class="comment">// throws FIXME if packet doesn't support it</span>
 185 <a name="l00163"></a>00163         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classBarry_1_1DBPacket.html#0efa0a4b999ca8fab4a628796181205a" title="Returns the database operation code from the receive packet, assuming that receive...">DBOperation</a>() <span class="keyword">const</span>; <span class="comment">// throws Error on size trouble</span>
 186 <a name="l00164"></a>00164
 187 <a name="l00165"></a>00165         <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DBPacket.html#43b96166db565fb8b37085d06d3a446c" title="Parses the data in the receive buffer, and attempts to be smart about it, using the...">Parse</a>(<a class="code" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> &amp;parser, <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); <span class="comment">// switches based on last m_send command</span>
 188 <a name="l00166"></a>00166
 189 <a name="l00167"></a>00167         <span class="comment">// response parsers</span>
 190 <a name="l00168"></a>00168 };
 191 <a name="l00169"></a>00169
 192 <a name="l00170"></a>00170
 193 <a name="l00171"></a>00171 <span class="comment">//</span>
 194 <a name="l00172"></a>00172 <span class="comment">// JLPacket class</span>
 195 <a name="l00173"></a>00173 <span class="comment">//</span><span class="comment"></span>
 196 <a name="l00174"></a>00174 <span class="comment">/// Provides an API for building and analyzing raw Javaloader protocol packets.</span>
 197 <a name="l00175"></a>00175 <span class="comment">/// This class relies on 3 external objects:</span>
 198 <a name="l00176"></a>00176 <span class="comment">/// a command send Data buffer (which can be fairly small), a data</span>
 199 <a name="l00177"></a>00177 <span class="comment">/// or argument send Data buffer, and a receive data buffer.  Socket and</span>
 200 <a name="l00178"></a>00178 <span class="comment">/// connection details are retrieved on a readonly basis from the</span>
 201 <a name="l00179"></a>00179 <span class="comment">/// Mode::JavaLoader object, but all buffers can be modified.</span>
 202 <a name="l00180"></a>00180 <span class="comment">///</span>
 203 <a name="l00181"></a>00181 <span class="comment">/// Note that the receive buffer may be modified</span>
 204 <a name="l00182"></a>00182 <span class="comment">/// during a packet send, and this JLPacket class provides API helpers</span>
 205 <a name="l00183"></a>00183 <span class="comment">/// to analyze the results.</span>
 206 <a name="l00184"></a>00184 <span class="comment">///</span>
 207 <a name="l00185"></a><a class="code" href="classBarry_1_1JLPacket.html">00185</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classBarry_1_1JLPacket.html" title="Provides an API for building and analyzing raw Javaloader protocol packets.">JLPacket</a> : <span class="keyword">public</span> Packet
 208 <a name="l00186"></a>00186 {
 209 <a name="l00187"></a>00187         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &amp;quot;logical socket&amp;quot; in the Blackberry USB protocol.">Socket</a>;
 210 <a name="l00188"></a>00188
 211 <a name="l00189"></a>00189 <span class="keyword">private</span>:
 212 <a name="l00190"></a>00190         Data &amp;m_cmd, &amp;m_data;
 213 <a name="l00191"></a>00191         <span class="keywordtype">int</span> m_last_set_size;
 214 <a name="l00192"></a>00192
 215 <a name="l00193"></a>00193 <span class="keyword">public</span>:
 216 <a name="l00194"></a>00194         <a class="code" href="classBarry_1_1JLPacket.html" title="Provides an API for building and analyzing raw Javaloader protocol packets.">JLPacket</a>(Data &amp;cmd, Data &amp;send, Data &amp;receive);
 217 <a name="l00195"></a>00195         ~<a class="code" href="classBarry_1_1JLPacket.html" title="Provides an API for building and analyzing raw Javaloader protocol packets.">JLPacket</a>();
 218 <a name="l00196"></a>00196 <span class="comment"></span>
 219 <a name="l00197"></a>00197 <span class="comment">        //////////////////////////////////</span>
 220 <a name="l00198"></a>00198 <span class="comment"></span>        <span class="comment">// meta access</span>
 221 <a name="l00199"></a>00199
 222 <a name="l00200"></a>00200         <span class="keywordtype">bool</span> HasData()<span class="keyword"> const    </span>{ <span class="keywordflow">return</span> m_last_set_size == 2; }
 223 <a name="l00201"></a>00201         Data&amp; GetReceive()      { <span class="keywordflow">return</span> m_receive; }
 224 <a name="l00202"></a>00202 <span class="comment"></span>
 225 <a name="l00203"></a>00203 <span class="comment">        //////////////////////////////////</span>
 226 <a name="l00204"></a>00204 <span class="comment"></span>        <span class="comment">// packet building</span>
 227 <a name="l00205"></a>00205
 228 <a name="l00206"></a>00206         <span class="comment">// commands that correspond to the operation</span>
 229 <a name="l00207"></a>00207         <span class="comment">// constants in protocol.h</span>
 230 <a name="l00208"></a>00208
 231 <a name="l00209"></a>00209         <span class="comment">// returns 1 or 2 depending on whether cmd or cmd+send are available</span>
 232 <a name="l00210"></a>00210         <span class="keywordtype">int</span> SimpleCmd(uint8_t cmd, uint8_t unknown = 0, uint16_t size = 0);
 233 <a name="l00211"></a>00211         <span class="keywordtype">int</span> SimpleData(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint16_t size);
 234 <a name="l00212"></a>00212         <span class="keywordtype">int</span> BigEndianData(uint16_t value);
 235 <a name="l00213"></a>00213         <span class="keywordtype">int</span> BigEndianData(uint32_t value);
 236 <a name="l00214"></a>00214
 237 <a name="l00215"></a>00215         <span class="keywordtype">int</span> Hello()             { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_HELLO); }
 238 <a name="l00216"></a>00216         <span class="keywordtype">int</span> Goodbye()           { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GOODBYE); }
 239 <a name="l00217"></a>00217         <span class="keywordtype">int</span> SetUnknown1();
 240 <a name="l00218"></a>00218         <span class="keywordtype">int</span> SetCodFilename(<span class="keyword">const</span> std::string &amp;filename);
 241 <a name="l00219"></a>00219         <span class="keywordtype">int</span> SetCodSize(off_t size);
 242 <a name="l00220"></a>00220         <span class="keywordtype">int</span> SetTime(time_t when);
 243 <a name="l00221"></a>00221         <span class="keywordtype">int</span> GetScreenshot();
 244 <a name="l00222"></a>00222         <span class="keywordtype">int</span> GetData()           { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_SEND_DATA); }
 245 <a name="l00223"></a>00223         <span class="keywordtype">int</span> DeviceInfo()        { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_DEVICE_INFO); }
 246 <a name="l00224"></a>00224         <span class="keywordtype">int</span> OsMetrics()         { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_OS_METRICS); }
 247 <a name="l00225"></a>00225         <span class="keywordtype">int</span> BootromMetrics()    { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_BOOTROM_METRICS); }
 248 <a name="l00226"></a>00226         <span class="keywordtype">int</span> GetDirectory()      { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GET_DIRECTORY); }
 249 <a name="l00227"></a>00227         <span class="keywordtype">int</span> GetSubDir(uint16_t <span class="keywordtype">id</span>);
 250 <a name="l00228"></a>00228         <span class="keywordtype">int</span> GetDirEntry(uint8_t entry_cmd, uint16_t <span class="keywordtype">id</span>);
 251 <a name="l00229"></a>00229         <span class="keywordtype">int</span> Erase(uint16_t cmd, uint16_t <span class="keywordtype">id</span>);
 252 <a name="l00230"></a>00230         <span class="keywordtype">int</span> GetEventlog()       { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GET_LOG); }
 253 <a name="l00231"></a>00231         <span class="keywordtype">int</span> GetEventlogEntry(uint16_t entry_num);
 254 <a name="l00232"></a>00232         <span class="keywordtype">int</span> ClearEventlog()     { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_CLEAR_LOG); }
 255 <a name="l00233"></a>00233         <span class="keywordtype">int</span> SaveModule(uint16_t <span class="keywordtype">id</span>);
 256 <a name="l00234"></a>00234         <span class="keywordtype">int</span> PutData(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, uint16_t size);
 257 <a name="l00235"></a>00235         <span class="keywordtype">int</span> WipeApps()          { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_WIPE_APPS); }
 258 <a name="l00236"></a>00236         <span class="keywordtype">int</span> WipeFs()            { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_WIPE_FS); }
 259 <a name="l00237"></a>00237         <span class="keywordtype">int</span> LogStackTraces()    { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_LOG_STRACES); }
 260 <a name="l00238"></a>00238         <span class="keywordtype">int</span> ResetToFactory()    { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_RESET_FACTORY); }
 261 <a name="l00239"></a>00239 <span class="comment"></span>
 262 <a name="l00240"></a>00240 <span class="comment">        //////////////////////////////////</span>
 263 <a name="l00241"></a>00241 <span class="comment"></span>        <span class="comment">// response analysis</span>
 264 <a name="l00242"></a>00242         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Size();
 265 <a name="l00243"></a>00243 };
 266 <a name="l00244"></a>00244
 267 <a name="l00245"></a>00245
 268 <a name="l00246"></a>00246 } <span class="comment">// namespace Barry</span>
 269 <a name="l00247"></a>00247
 270 <a name="l00248"></a>00248 <span class="preprocessor">#endif</span>
 271 <a name="l00249"></a>00249 <span class="preprocessor"></span>
 272 </pre></div></div>
 273 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:53 2009 for Barry by&nbsp;
 274 <a href="http://www.doxygen.org/index.html">
 275 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 276 </body>
 277 </html>