<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: packet.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="annotated.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="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<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>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file packet.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Low level protocol packet builder class.</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">/// Has knowledge of specific protocol commands in order</span>
<a name="l00005"></a>00005 <span class="comment"></span><span class="comment">/// to hide protocol details behind an API.</span>
<a name="l00006"></a>00006 <span class="comment"></span><span class="comment">///</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">/*</span>
<a name="l00009"></a>00009 <span class="comment"> Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00012"></a>00012 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00013"></a>00013 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00014"></a>00014 <span class="comment"> (at your option) any later version.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00017"></a>00017 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00018"></a>00018 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00021"></a>00021 <span class="comment"> root directory of this project for more details.</span>
<a name="l00022"></a>00022 <span class="comment">*/</span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#ifndef __BARRY_PACKET_H__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PACKET_H__</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <string></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <stdint.h></span>
<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>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry { <span class="keyword">class </span>Data; }
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// forward declarations</span>
<a name="l00036"></a>00036 <span class="keyword">class </span>Parser;
<a name="l00037"></a>00037 <span class="keyword">class </span>Builder;
<a name="l00038"></a>00038 <span class="keyword">class </span>SocketZero;
<a name="l00039"></a>00039 <span class="keyword">class </span>Socket;
<a name="l00040"></a>00040 <span class="keyword">class </span>IConverter;
<a name="l00041"></a>00041 <span class="keyword">namespace </span>Mode {
<a name="l00042"></a>00042 <span class="keyword">class </span>Desktop;
<a name="l00043"></a>00043 <span class="keyword">class </span>JavaLoader;
<a name="l00044"></a>00044 }
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classBarry_1_1Packet.html">00046</a> <span class="keyword">class </span><a class="code" href="classBarry_1_1Packet.html">Packet</a>
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a>;
<a name="l00049"></a>00049 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">protected</span>:
<a name="l00052"></a>00052 <a class="code" href="classBarry_1_1Data.html">Data</a> &m_send, &m_receive;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <a class="code" href="classBarry_1_1Data.html">Data</a>& GetSend() { <span class="keywordflow">return</span> m_send; }
<a name="l00055"></a>00055 <a class="code" href="classBarry_1_1Data.html">Data</a>& GetReceive() { <span class="keywordflow">return</span> m_receive; }
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a>00058 <a class="code" href="classBarry_1_1Packet.html">Packet</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive)
<a name="l00059"></a>00059 : m_send(send), m_receive(receive)
<a name="l00060"></a>00060 {}
<a name="l00061"></a>00061 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Packet.html">Packet</a>() {}
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment"> //////////////////////////////////</span>
<a name="l00064"></a>00064 <span class="comment"></span> <span class="comment">// common response analysis</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classBarry_1_1Packet.html#a764cefd38c2dc1970fccabc01044687d" title="Returns the command value of the receive packet.">Command</a>() <span class="keyword">const</span>; <span class="comment">// throws Error if receive isn't big enough</span>
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">//</span>
<a name="l00070"></a>00070 <span class="comment">// ZeroPacket class</span>
<a name="l00071"></a>00071 <span class="comment">//</span><span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment">/// Provides an API for building and analyzing socket-0 protocol packets.</span>
<a name="l00073"></a>00073 <span class="comment">/// This class relies on 2 external objects: a send and receive Data buffer.</span>
<a name="l00074"></a>00074 <span class="comment">///</span>
<a name="l00075"></a>00075 <span class="comment">/// Note that the receive buffer may be modified</span>
<a name="l00076"></a>00076 <span class="comment">/// during a packet send, and this class provides API helpers</span>
<a name="l00077"></a>00077 <span class="comment">/// to analyze the results.</span>
<a name="l00078"></a>00078 <span class="comment">///</span>
<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> <a class="code" href="classBarry_1_1Packet.html">Packet</a>
<a name="l00080"></a>00080 {
<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 &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keyword">public</span>:
<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>(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<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>();
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"> //////////////////////////////////</span>
<a name="l00088"></a>00088 <span class="comment"></span> <span class="comment">// meta access</span>
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> //////////////////////////////////</span>
<a name="l00091"></a>00091 <span class="comment"></span> <span class="comment">// packet building</span>
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1ZeroPacket.html#a7737431baba17201d588f1dba4c8bbe0" 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);
<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1ZeroPacket.html#a274fb9e330544f188df45f03ebe9180a" title="Builds command packet for sending echo request.">Echo</a>(uint64_t us_ticks);
<a name="l00095"></a>00095 <span class="keywordtype">void</span> Reset();
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment"> //////////////////////////////////</span>
<a name="l00099"></a>00099 <span class="comment"></span> <span class="comment">// response analysis</span>
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ObjectID() <span class="keyword">const</span>;
<a name="l00102"></a>00102 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> AttributeID() <span class="keyword">const</span>;
<a name="l00103"></a>00103 uint32_t ChallengeSeed() <span class="keyword">const</span>;
<a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> RemainingTries() <span class="keyword">const</span>;
<a name="l00105"></a>00105 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SocketResponse() <span class="keyword">const</span>;
<a name="l00106"></a>00106 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> SocketSequence() <span class="keyword">const</span>;
<a name="l00107"></a>00107 uint8_t CommandResponse() <span class="keyword">const</span>;
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">//</span>
<a name="l00112"></a>00112 <span class="comment">// DBPacket class</span>
<a name="l00113"></a>00113 <span class="comment">//</span><span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment">/// Provides an API for building and analyzing raw DB protocol packets.</span>
<a name="l00115"></a>00115 <span class="comment">/// This class relies on 3 external objects: a Mode::Desktop object,</span>
<a name="l00116"></a>00116 <span class="comment">/// a send Data buffer, and a receive data buffer. Socket and</span>
<a name="l00117"></a>00117 <span class="comment">/// connection details are retrieved on a readonly basis from the</span>
<a name="l00118"></a>00118 <span class="comment">/// Mode::Desktop object, but both send and receive buffers can be</span>
<a name="l00119"></a>00119 <span class="comment">/// modified.</span>
<a name="l00120"></a>00120 <span class="comment">///</span>
<a name="l00121"></a>00121 <span class="comment">/// Note that the receive buffer may be modified</span>
<a name="l00122"></a>00122 <span class="comment">/// during a packet send, and this DBPacket class provides API helpers</span>
<a name="l00123"></a>00123 <span class="comment">/// to analyze the results.</span>
<a name="l00124"></a>00124 <span class="comment">///</span>
<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> <a class="code" href="classBarry_1_1Packet.html">Packet</a>
<a name="l00126"></a>00126 {
<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 &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="keyword">private</span>:
<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> &m_con;
<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>
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keyword">protected</span>:
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keyword">public</span>:
<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> &con, <a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<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>();
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment"> //////////////////////////////////</span>
<a name="l00140"></a>00140 <span class="comment"></span> <span class="comment">// meta access</span>
<a name="l00141"></a>00141 <span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment"> //////////////////////////////////</span>
<a name="l00143"></a>00143 <span class="comment"></span> <span class="comment">// packet building</span>
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// commands that correspond to the DB operation</span>
<a name="l00146"></a>00146 <span class="comment">// constants in protocol.h</span>
<a name="l00147"></a>00147 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#aace85c6dd63c5f85e21e9f61e10e5af5" 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);
<a name="l00148"></a>00148 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#a206e98e5159e7fe7790d4976d0f039a0" title="Builds a command packet for the GET_DBDB command code, placing the data in m_send...">GetDBDB</a>();
<a name="l00149"></a>00149 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#a07e2e8ca566a1f4d7cc493983b56c32b" 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);
<a name="l00150"></a>00150 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#a9f0237393389b714f30bf56e616183dd" 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);
<a name="l00151"></a>00151 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#afb9625f072f936a03ebee1ac64b78bf4" 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);
<a name="l00152"></a>00152 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#a95355f6de0ab12e9eacd0727e8a66965" 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);
<a name="l00153"></a>00153 <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DBPacket.html#a7a41833dcc12c2823cd54991161e8d26" 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> &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);
<a name="l00154"></a>00154 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DBPacket.html#a173b8eb90186edc54e8a679d7498bcb5" 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);
<a name="l00155"></a>00155 <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DBPacket.html#a26c4025403d129f658c1919190c0a0f0" 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> &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);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment"> //////////////////////////////////</span>
<a name="l00159"></a>00159 <span class="comment"></span> <span class="comment">// response analysis</span>
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">// DB command response functions</span>
<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>
<a name="l00163"></a>00163 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classBarry_1_1DBPacket.html#a0efa0a4b999ca8fab4a628796181205a" 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>
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DBPacket.html#a43b96166db565fb8b37085d06d3a446c" 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> &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>
<a name="l00166"></a>00166
<a name="l00167"></a>00167 <span class="comment">// response parsers</span>
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="comment">//</span>
<a name="l00172"></a>00172 <span class="comment">// JLPacket class</span>
<a name="l00173"></a>00173 <span class="comment">//</span><span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment">/// Provides an API for building and analyzing raw Javaloader protocol packets.</span>
<a name="l00175"></a>00175 <span class="comment">/// This class relies on 3 external objects:</span>
<a name="l00176"></a>00176 <span class="comment">/// a command send Data buffer (which can be fairly small), a data</span>
<a name="l00177"></a>00177 <span class="comment">/// or argument send Data buffer, and a receive data buffer. Socket and</span>
<a name="l00178"></a>00178 <span class="comment">/// connection details are retrieved on a readonly basis from the</span>
<a name="l00179"></a>00179 <span class="comment">/// Mode::JavaLoader object, but all buffers can be modified.</span>
<a name="l00180"></a>00180 <span class="comment">///</span>
<a name="l00181"></a>00181 <span class="comment">/// Note that the receive buffer may be modified</span>
<a name="l00182"></a>00182 <span class="comment">/// during a packet send, and this JLPacket class provides API helpers</span>
<a name="l00183"></a>00183 <span class="comment">/// to analyze the results.</span>
<a name="l00184"></a>00184 <span class="comment">///</span>
<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> <a class="code" href="classBarry_1_1Packet.html">Packet</a>
<a name="l00186"></a>00186 {
<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 &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="keyword">private</span>:
<a name="l00190"></a>00190 <a class="code" href="classBarry_1_1Data.html">Data</a> &m_cmd, &m_data;
<a name="l00191"></a>00191 <span class="keywordtype">int</span> m_last_set_size;
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">public</span>:
<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>(<a class="code" href="classBarry_1_1Data.html">Data</a> &cmd, <a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<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>();
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment"> //////////////////////////////////</span>
<a name="l00198"></a>00198 <span class="comment"></span> <span class="comment">// meta access</span>
<a name="l00199"></a>00199
<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; }
<a name="l00201"></a>00201 <a class="code" href="classBarry_1_1Data.html">Data</a>& GetReceive() { <span class="keywordflow">return</span> m_receive; }
<a name="l00202"></a>00202 <span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment"> //////////////////////////////////</span>
<a name="l00204"></a>00204 <span class="comment"></span> <span class="comment">// packet building</span>
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="comment">// commands that correspond to the operation</span>
<a name="l00207"></a>00207 <span class="comment">// constants in protocol.h</span>
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="comment">// returns 1 or 2 depending on whether cmd or cmd+send are available</span>
<a name="l00210"></a>00210 <span class="keywordtype">int</span> SimpleCmd(uint8_t cmd, uint8_t unknown = 0, uint16_t size = 0);
<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);
<a name="l00212"></a>00212 <span class="keywordtype">int</span> BigEndianData(uint16_t value);
<a name="l00213"></a>00213 <span class="keywordtype">int</span> BigEndianData(uint32_t value);
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="keywordtype">int</span> Hello() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_HELLO); }
<a name="l00216"></a>00216 <span class="keywordtype">int</span> Goodbye() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GOODBYE); }
<a name="l00217"></a>00217 <span class="keywordtype">int</span> SetUnknown1();
<a name="l00218"></a>00218 <span class="keywordtype">int</span> SetCodFilename(<span class="keyword">const</span> std::string &filename);
<a name="l00219"></a>00219 <span class="keywordtype">int</span> SetCodSize(off_t size);
<a name="l00220"></a>00220 <span class="keywordtype">int</span> SetTime(time_t when);
<a name="l00221"></a>00221 <span class="keywordtype">int</span> GetScreenshot();
<a name="l00222"></a>00222 <span class="keywordtype">int</span> GetData() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_SEND_DATA); }
<a name="l00223"></a>00223 <span class="keywordtype">int</span> DeviceInfo() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_DEVICE_INFO); }
<a name="l00224"></a>00224 <span class="keywordtype">int</span> OsMetrics() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_OS_METRICS); }
<a name="l00225"></a>00225 <span class="keywordtype">int</span> BootromMetrics() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_BOOTROM_METRICS); }
<a name="l00226"></a>00226 <span class="keywordtype">int</span> GetDirectory() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GET_DIRECTORY); }
<a name="l00227"></a>00227 <span class="keywordtype">int</span> GetSubDir(uint16_t <span class="keywordtype">id</span>);
<a name="l00228"></a>00228 <span class="keywordtype">int</span> GetDirEntry(uint8_t entry_cmd, uint16_t <span class="keywordtype">id</span>);
<a name="l00229"></a>00229 <span class="keywordtype">int</span> Erase(uint16_t cmd, uint16_t <span class="keywordtype">id</span>);
<a name="l00230"></a>00230 <span class="keywordtype">int</span> GetEventlog() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_GET_LOG); }
<a name="l00231"></a>00231 <span class="keywordtype">int</span> GetEventlogEntry(uint16_t entry_num);
<a name="l00232"></a>00232 <span class="keywordtype">int</span> ClearEventlog() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_CLEAR_LOG); }
<a name="l00233"></a>00233 <span class="keywordtype">int</span> SaveModule(uint16_t <span class="keywordtype">id</span>);
<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);
<a name="l00235"></a>00235 <span class="keywordtype">int</span> WipeApps() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_WIPE_APPS); }
<a name="l00236"></a>00236 <span class="keywordtype">int</span> WipeFs() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_WIPE_FS); }
<a name="l00237"></a>00237 <span class="keywordtype">int</span> LogStackTraces() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_LOG_STRACES); }
<a name="l00238"></a>00238 <span class="keywordtype">int</span> ResetToFactory() { <span class="keywordflow">return</span> SimpleCmd(SB_COMMAND_JL_RESET_FACTORY); }
<a name="l00239"></a>00239 <span class="comment"></span>
<a name="l00240"></a>00240 <span class="comment"> //////////////////////////////////</span>
<a name="l00241"></a>00241 <span class="comment"></span> <span class="comment">// response analysis</span>
<a name="l00242"></a>00242 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Size();
<a name="l00243"></a>00243 };
<a name="l00244"></a>00244
<a name="l00245"></a>00245
<a name="l00246"></a>00246 <span class="comment">//</span>
<a name="l00247"></a>00247 <span class="comment">// JVMPacket class</span>
<a name="l00248"></a>00248 <span class="comment">//</span><span class="comment"></span>
<a name="l00249"></a>00249 <span class="comment">/// Provides an API for building and analyzing raw JavaDebug protocol packets.</span>
<a name="l00250"></a>00250 <span class="comment">/// This class relies on 3 external objects:</span>
<a name="l00251"></a>00251 <span class="comment">/// a command send Data buffer (which can be fairly small), a data</span>
<a name="l00252"></a>00252 <span class="comment">/// or argument send Data buffer, and a receive data buffer. Socket and</span>
<a name="l00253"></a>00253 <span class="comment">/// connection details are retrieved on a readonly basis from the</span>
<a name="l00254"></a>00254 <span class="comment">/// Mode::JavaDebug object, but all buffers can be modified.</span>
<a name="l00255"></a>00255 <span class="comment">///</span>
<a name="l00256"></a>00256 <span class="comment">/// Note that the receive buffer may be modified</span>
<a name="l00257"></a>00257 <span class="comment">/// during a packet send, and this JVMPacket class provides API helpers</span>
<a name="l00258"></a>00258 <span class="comment">/// to analyze the results.</span>
<a name="l00259"></a>00259 <span class="comment">///</span>
<a name="l00260"></a><a class="code" href="classBarry_1_1JVMPacket.html">00260</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classBarry_1_1JVMPacket.html" title="Provides an API for building and analyzing raw JavaDebug protocol packets.">JVMPacket</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Packet.html">Packet</a>
<a name="l00261"></a>00261 {
<a name="l00262"></a>00262 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00263"></a>00263
<a name="l00264"></a>00264 <span class="keyword">private</span>:
<a name="l00265"></a>00265 <a class="code" href="classBarry_1_1Data.html">Data</a> &m_cmd;
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="keyword">public</span>:
<a name="l00268"></a>00268 <a class="code" href="classBarry_1_1JVMPacket.html" title="Provides an API for building and analyzing raw JavaDebug protocol packets.">JVMPacket</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &cmd, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<a name="l00269"></a>00269 ~<a class="code" href="classBarry_1_1JVMPacket.html" title="Provides an API for building and analyzing raw JavaDebug protocol packets.">JVMPacket</a>();
<a name="l00270"></a>00270 <span class="comment"></span>
<a name="l00271"></a>00271 <span class="comment"> //////////////////////////////////</span>
<a name="l00272"></a>00272 <span class="comment"></span> <span class="comment">// meta access</span>
<a name="l00273"></a>00273
<a name="l00274"></a>00274 <a class="code" href="classBarry_1_1Data.html">Data</a>& GetReceive() { <span class="keywordflow">return</span> m_receive; }
<a name="l00275"></a>00275 <span class="comment"></span>
<a name="l00276"></a>00276 <span class="comment"> //////////////////////////////////</span>
<a name="l00277"></a>00277 <span class="comment"></span> <span class="comment">// packet building</span>
<a name="l00278"></a>00278
<a name="l00279"></a>00279 <span class="comment">// commands that correspond to the operation</span>
<a name="l00280"></a>00280 <span class="comment">// constants in protocol.h</span>
<a name="l00281"></a>00281
<a name="l00282"></a>00282 <span class="comment">// returns 1 or 2 depending on whether cmd or cmd+send are available</span>
<a name="l00283"></a>00283 <span class="keywordtype">void</span> SimpleCmd(uint8_t cmd);
<a name="l00284"></a>00284 <span class="keywordtype">void</span> ComplexCmd(uint8_t cmd, <span class="keyword">const</span> <span class="keywordtype">void</span> *param, uint16_t size = 0);
<a name="l00285"></a>00285
<a name="l00286"></a>00286 <span class="keywordtype">void</span> Unknown01(); <span class="comment">// Command 0x53</span>
<a name="l00287"></a>00287 <span class="keywordtype">void</span> Unknown02(); <span class="comment">// Command 0x01</span>
<a name="l00288"></a>00288 <span class="keywordtype">void</span> Unknown03(); <span class="comment">// Command 0x6f</span>
<a name="l00289"></a>00289 <span class="keywordtype">void</span> Unknown04(); <span class="comment">// Command 0x8a</span>
<a name="l00290"></a>00290 <span class="keywordtype">void</span> Unknown05(); <span class="comment">// Command 0x90</span>
<a name="l00291"></a>00291 <span class="keywordtype">void</span> Unknown06(); <span class="comment">// Command 0x44</span>
<a name="l00292"></a>00292 <span class="keywordtype">void</span> Unknown07(); <span class="comment">// Command 0x45</span>
<a name="l00293"></a>00293 <span class="keywordtype">void</span> Unknown08(); <span class="comment">// Command 0x54</span>
<a name="l00294"></a>00294 <span class="keywordtype">void</span> Unknown09(); <span class="comment">// Command 0x33</span>
<a name="l00295"></a>00295 <span class="keywordtype">void</span> Unknown10(); <span class="comment">// Command 0x46</span>
<a name="l00296"></a>00296 <span class="keywordtype">void</span> Unknown11(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x0e</span>
<a name="l00297"></a>00297 <span class="keywordtype">void</span> Unknown12(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x50</span>
<a name="l00298"></a>00298 <span class="keywordtype">void</span> Unknown13(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x0d</span>
<a name="l00299"></a>00299 <span class="keywordtype">void</span> Unknown14(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x85</span>
<a name="l00300"></a>00300 <span class="keywordtype">void</span> Unknown15(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x84</span>
<a name="l00301"></a>00301 <span class="keywordtype">void</span> GetModulesList(uint32_t <span class="keywordtype">id</span>); <span class="comment">// Command 0x8d</span>
<a name="l00302"></a>00302 <span class="keywordtype">void</span> GetThreadsList(); <span class="comment">// Command 0x08</span>
<a name="l00303"></a>00303 <span class="keywordtype">void</span> GetConsoleMessage();
<a name="l00304"></a>00304 <span class="keywordtype">void</span> Go(); <span class="comment">// Command mal formed :)</span>
<a name="l00305"></a>00305 <span class="keywordtype">void</span> Stop(); <span class="comment">// Command 0x02</span>
<a name="l00306"></a>00306 <span class="keywordtype">void</span> GetStatus(); <span class="comment">// Command 0x06</span>
<a name="l00307"></a>00307 <span class="comment"></span>
<a name="l00308"></a>00308 <span class="comment"> //////////////////////////////////</span>
<a name="l00309"></a>00309 <span class="comment"></span> <span class="comment">// response analysis</span>
<a name="l00310"></a>00310 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Size();
<a name="l00311"></a>00311 };
<a name="l00312"></a>00312
<a name="l00313"></a>00313
<a name="l00314"></a>00314 } <span class="comment">// namespace Barry</span>
<a name="l00315"></a>00315
<a name="l00316"></a>00316 <span class="preprocessor">#endif</span>
<a name="l00317"></a>00317 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
