<!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: socket.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>socket.cc</h1><a href="socket_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 socket.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Class wrapper to encapsulate the Blackberry USB logical socket</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="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span>
<a name="l00024"></a>00024 <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="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.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 "debug.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="packet_8h.html" title="Low level protocol packet builder class.">packet.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "sha1.h"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <sstream></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <string.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">using namespace </span>Usb;
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Barry {
<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">// SocketZero class</span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 SocketZero::SocketZero( SocketRoutingQueue &queue,
<a name="l00044"></a>00044 <span class="keywordtype">int</span> writeEndpoint,
<a name="l00045"></a>00045 uint8_t zeroSocketSequenceStart)
<a name="l00046"></a>00046 : m_dev(0),
<a name="l00047"></a>00047 m_queue(&queue),
<a name="l00048"></a>00048 m_writeEp(writeEndpoint),
<a name="l00049"></a>00049 m_readEp(0),
<a name="l00050"></a>00050 m_zeroSocketSequence(zeroSocketSequenceStart),
<a name="l00051"></a>00051 m_sequenceId(0),
<a name="l00052"></a>00052 m_halfOpen(false),
<a name="l00053"></a>00053 m_challengeSeed(0),
<a name="l00054"></a>00054 m_remainingTries(0),
<a name="l00055"></a>00055 m_hideSequencePacket(true),
<a name="l00056"></a>00056 m_resetOnClose(false)
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a>00060 SocketZero::SocketZero( Device &dev,
<a name="l00061"></a>00061 <span class="keywordtype">int</span> writeEndpoint, <span class="keywordtype">int</span> readEndpoint,
<a name="l00062"></a>00062 uint8_t zeroSocketSequenceStart)
<a name="l00063"></a>00063 : m_dev(&dev),
<a name="l00064"></a>00064 m_queue(0),
<a name="l00065"></a>00065 m_writeEp(writeEndpoint),
<a name="l00066"></a>00066 m_readEp(readEndpoint),
<a name="l00067"></a>00067 m_zeroSocketSequence(zeroSocketSequenceStart),
<a name="l00068"></a>00068 m_sequenceId(0),
<a name="l00069"></a>00069 m_halfOpen(false),
<a name="l00070"></a>00070 m_challengeSeed(0),
<a name="l00071"></a>00071 m_remainingTries(0),
<a name="l00072"></a>00072 m_hideSequencePacket(true),
<a name="l00073"></a>00073 m_resetOnClose(false)
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076
<a name="l00077"></a>00077 SocketZero::~SocketZero()
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <span class="comment">// nothing to close for socket zero</span>
<a name="l00080"></a>00080 }
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">///////////////////////////////////////</span>
<a name="l00084"></a>00084 <span class="comment"></span><span class="comment">// Socket Zero static calls</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// appends fragment to whole... if whole is empty, simply copies, and</span>
<a name="l00087"></a>00087 <span class="comment">// sets command to DATA instead of FRAGMENTED. Always updates the</span>
<a name="l00088"></a>00088 <span class="comment">// packet size of whole, to reflect the total size</span>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> SocketZero::AppendFragment(Data &whole, <span class="keyword">const</span> Data &fragment)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keywordflow">if</span>( whole.GetSize() == 0 ) {
<a name="l00092"></a>00092 <span class="comment">// empty, so just copy</span>
<a name="l00093"></a>00093 whole = fragment;
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095 <span class="keywordflow">else</span> {
<a name="l00096"></a>00096 <span class="comment">// has some data already, so just append</span>
<a name="l00097"></a>00097 <span class="keywordtype">int</span> size = whole.GetSize();
<a name="l00098"></a>00098 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf = whole.GetBuffer(size + fragment.GetSize());
<a name="l00099"></a>00099 MAKE_PACKET(fpack, fragment);
<a name="l00100"></a>00100 <span class="keywordtype">int</span> fragsize = fragment.GetSize() - SB_FRAG_HEADER_SIZE;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 memcpy(buf+size, &fpack->u.db.u.fragment, fragsize);
<a name="l00103"></a>00103 whole.ReleaseBuffer(size + fragsize);
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="comment">// update whole's size and command type for future sanity</span>
<a name="l00107"></a>00107 Barry::Protocol::Packet *wpack = (Barry::Protocol::Packet *) whole.GetBuffer();
<a name="l00108"></a>00108 wpack->size = htobs((uint16_t) whole.GetSize());
<a name="l00109"></a>00109 wpack->command = SB_COMMAND_DB_DATA;
<a name="l00110"></a>00110 <span class="comment">// don't need to call ReleaseBuffer here, since we're not changing</span>
<a name="l00111"></a>00111 <span class="comment">// the real data size, and ReleaseBuffer was called above during copy</span>
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">// If offset is 0, starts fresh, taking the first fragment packet size chunk</span>
<a name="l00115"></a>00115 <span class="comment">// out of whole and creating a sendable packet in fragment. Returns the</span>
<a name="l00116"></a>00116 <span class="comment">// next offset if there is still more data, or 0 if finished.</span>
<a name="l00117"></a>00117 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SocketZero::MakeNextFragment(<span class="keyword">const</span> Data &whole, Data &fragment, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset)
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 <span class="comment">// sanity check</span>
<a name="l00120"></a>00120 <span class="keywordflow">if</span>( whole.GetSize() < SB_FRAG_HEADER_SIZE ) {
<a name="l00121"></a>00121 eout(<span class="stringliteral">"Whole packet too short to fragment: "</span> << whole.GetSize());
<a name="l00122"></a>00122 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: Whole packet too short to fragment"</span>);
<a name="l00123"></a>00123 }
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">// calculate size</span>
<a name="l00126"></a>00126 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> todo = whole.GetSize() - SB_FRAG_HEADER_SIZE - offset;
<a name="l00127"></a>00127 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nextOffset = 0;
<a name="l00128"></a>00128 <span class="keywordflow">if</span>( todo > (MAX_PACKET_SIZE - SB_FRAG_HEADER_SIZE) ) {
<a name="l00129"></a>00129 todo = MAX_PACKET_SIZE - SB_FRAG_HEADER_SIZE;
<a name="l00130"></a>00130 nextOffset = offset + todo;
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">// create fragment header</span>
<a name="l00134"></a>00134 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf = fragment.GetBuffer(SB_FRAG_HEADER_SIZE + todo);
<a name="l00135"></a>00135 memcpy(buf, whole.GetData(), SB_FRAG_HEADER_SIZE);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="comment">// copy over a fragment size of data</span>
<a name="l00138"></a>00138 memcpy(buf + SB_FRAG_HEADER_SIZE, whole.GetData() + SB_FRAG_HEADER_SIZE + offset, todo);
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="comment">// update fragment's size and command type</span>
<a name="l00141"></a>00141 Barry::Protocol::Packet *wpack = (Barry::Protocol::Packet *) buf;
<a name="l00142"></a>00142 wpack->size = htobs((uint16_t) (todo + SB_FRAG_HEADER_SIZE));
<a name="l00143"></a>00143 <span class="keywordflow">if</span>( nextOffset )
<a name="l00144"></a>00144 wpack->command = SB_COMMAND_DB_FRAGMENTED;
<a name="l00145"></a>00145 <span class="keywordflow">else</span>
<a name="l00146"></a>00146 wpack->command = SB_COMMAND_DB_DATA;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">// adjust the new fragment size</span>
<a name="l00149"></a>00149 fragment.ReleaseBuffer(SB_FRAG_HEADER_SIZE + todo);
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="comment">// return next round</span>
<a name="l00152"></a>00152 <span class="keywordflow">return</span> nextOffset;
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment">///////////////////////////////////////</span>
<a name="l00157"></a>00157 <span class="comment"></span><span class="comment">// SocketZero private API</span>
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">//</span>
<a name="l00160"></a>00160 <span class="comment">// FIXME - not sure yet whether sequence ID's are per socket or not... if</span>
<a name="l00161"></a>00161 <span class="comment">// they are per socket, then this global sequence behaviour will not work,</span>
<a name="l00162"></a>00162 <span class="comment">// and we need to track m_sequenceId on a Socket level.</span>
<a name="l00163"></a>00163 <span class="comment">//</span>
<a name="l00164"></a>00164 <span class="keywordtype">void</span> SocketZero::CheckSequence(uint16_t socket, <span class="keyword">const</span> Data &seq)
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 MAKE_PACKET(spack, seq);
<a name="l00167"></a>00167 <span class="keywordflow">if</span>( (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) seq.GetSize() < SB_SEQUENCE_PACKET_SIZE ) {
<a name="l00168"></a>00168 eout(<span class="stringliteral">"Short sequence packet:\n"</span> << seq);
<a name="l00169"></a>00169 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: invalid sequence packet"</span>);
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="comment">// we'll cheat here... if the packet's sequence is 0, we'll</span>
<a name="l00173"></a>00173 <span class="comment">// silently restart, otherwise, fail</span>
<a name="l00174"></a>00174 uint32_t sequenceId = btohl(spack->u.sequence.sequenceId);
<a name="l00175"></a>00175 <span class="keywordflow">if</span>( sequenceId == 0 ) {
<a name="l00176"></a>00176 <span class="comment">// silently restart (will advance below)</span>
<a name="l00177"></a>00177 m_sequenceId = 0;
<a name="l00178"></a>00178 }
<a name="l00179"></a>00179 <span class="keywordflow">else</span> {
<a name="l00180"></a>00180 <span class="keywordflow">if</span>( sequenceId != m_sequenceId ) {
<a name="l00181"></a>00181 <span class="keywordflow">if</span>( socket != 0 ) {
<a name="l00182"></a>00182 std::ostringstream oss;
<a name="l00183"></a>00183 oss << <span class="stringliteral">"Socket 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int)socket
<a name="l00184"></a>00184 << <span class="stringliteral">": out of sequence. "</span>
<a name="l00185"></a>00185 << <span class="stringliteral">"(Global sequence: "</span> << m_sequenceId
<a name="l00186"></a>00186 << <span class="stringliteral">". Packet sequence: "</span> << sequenceId
<a name="l00187"></a>00187 << <span class="stringliteral">")"</span>;
<a name="l00188"></a>00188 eout(oss.str());
<a name="l00189"></a>00189 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(oss.str());
<a name="l00190"></a>00190 }
<a name="l00191"></a>00191 <span class="keywordflow">else</span> {
<a name="l00192"></a>00192 dout(<span class="stringliteral">"Bad sequence on socket 0: expected: "</span>
<a name="l00193"></a>00193 << m_sequenceId
<a name="l00194"></a>00194 << <span class="stringliteral">". Packet sequence: "</span> << sequenceId);
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196 }
<a name="l00197"></a>00197 }
<a name="l00198"></a>00198
<a name="l00199"></a>00199 <span class="comment">// advance!</span>
<a name="l00200"></a>00200 m_sequenceId++;
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <span class="keywordtype">void</span> SocketZero::SendOpen(uint16_t socket, Data &receive)
<a name="l00204"></a>00204 {
<a name="l00205"></a>00205 <span class="comment">// build open command</span>
<a name="l00206"></a>00206 Barry::Protocol::Packet packet;
<a name="l00207"></a>00207 packet.socket = 0;
<a name="l00208"></a>00208 packet.size = htobs(SB_SOCKET_PACKET_HEADER_SIZE);
<a name="l00209"></a>00209 packet.command = SB_COMMAND_OPEN_SOCKET;
<a name="l00210"></a>00210 packet.u.socket.socket = htobs(socket);
<a name="l00211"></a>00211 packet.u.socket.sequence = m_zeroSocketSequence;<span class="comment">// overwritten by Send()</span>
<a name="l00212"></a>00212
<a name="l00213"></a>00213 Data send(&packet, SB_SOCKET_PACKET_HEADER_SIZE);
<a name="l00214"></a>00214 <span class="keywordflow">try</span> {
<a name="l00215"></a>00215 RawSend(send);
<a name="l00216"></a>00216 RawReceive(receive);
<a name="l00217"></a>00217 } <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="l00218"></a>00218 eeout(send, receive);
<a name="l00219"></a>00219 <span class="keywordflow">throw</span>;
<a name="l00220"></a>00220 }
<a name="l00221"></a>00221
<a name="l00222"></a>00222 <span class="comment">// check sequence ID</span>
<a name="l00223"></a>00223 Protocol::CheckSize(receive, SB_PACKET_HEADER_SIZE);
<a name="l00224"></a>00224 <span class="keywordflow">if</span>( IS_COMMAND(receive, SB_COMMAND_SEQUENCE_HANDSHAKE) ) {
<a name="l00225"></a>00225 CheckSequence(0, receive);
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="comment">// still need our ACK</span>
<a name="l00228"></a>00228 RawReceive(receive);
<a name="l00229"></a>00229 }
<a name="l00230"></a>00230
<a name="l00231"></a>00231 <span class="comment">// receive now holds the Open response</span>
<a name="l00232"></a>00232 }
<a name="l00233"></a>00233
<a name="l00234"></a>00234 <span class="comment">// SHA1 hashing logic based on Rick Scott's XmBlackBerry's send_password()</span>
<a name="l00235"></a>00235 <span class="keywordtype">void</span> SocketZero::SendPasswordHash(uint16_t socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *password, Data &receive)
<a name="l00236"></a>00236 {
<a name="l00237"></a>00237 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> pwdigest[SHA_DIGEST_LENGTH];
<a name="l00238"></a>00238 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> prefixedhash[SHA_DIGEST_LENGTH + 4];
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="comment">// first, hash the password by itself</span>
<a name="l00241"></a>00241 SHA1((<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *) password, strlen(password), pwdigest);
<a name="l00242"></a>00242
<a name="l00243"></a>00243 <span class="comment">// prefix the resulting hash with the provided seed</span>
<a name="l00244"></a>00244 uint32_t seed = htobl(m_challengeSeed);
<a name="l00245"></a>00245 memcpy(&prefixedhash[0], &seed, <span class="keyword">sizeof</span>(uint32_t));
<a name="l00246"></a>00246 memcpy(&prefixedhash[4], pwdigest, SHA_DIGEST_LENGTH);
<a name="l00247"></a>00247
<a name="l00248"></a>00248 <span class="comment">// hash again</span>
<a name="l00249"></a>00249 SHA1((<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *) prefixedhash, SHA_DIGEST_LENGTH + 4, pwdigest);
<a name="l00250"></a>00250
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="keywordtype">size_t</span> size = SB_SOCKET_PACKET_HEADER_SIZE + PASSWORD_CHALLENGE_SIZE;
<a name="l00253"></a>00253
<a name="l00254"></a>00254 <span class="comment">// build open command</span>
<a name="l00255"></a>00255 Barry::Protocol::Packet packet;
<a name="l00256"></a>00256 packet.socket = 0;
<a name="l00257"></a>00257 packet.size = htobs(size);
<a name="l00258"></a>00258 packet.command = SB_COMMAND_PASSWORD;
<a name="l00259"></a>00259 packet.u.socket.socket = htobs(socket);
<a name="l00260"></a>00260 packet.u.socket.sequence = m_zeroSocketSequence;<span class="comment">// overwritten by Send()</span>
<a name="l00261"></a>00261 packet.u.socket.u.password.remaining_tries = 0;
<a name="l00262"></a>00262 packet.u.socket.u.password.unknown = 0;
<a name="l00263"></a>00263 packet.u.socket.u.password.param = htobs(0x14); <span class="comment">// FIXME - what does this mean?</span>
<a name="l00264"></a>00264 memcpy(packet.u.socket.u.password.u.hash, pwdigest,
<a name="l00265"></a>00265 <span class="keyword">sizeof</span>(packet.u.socket.u.password.u.hash));
<a name="l00266"></a>00266
<a name="l00267"></a>00267 <span class="comment">// blank password hashes as we don't need these anymore</span>
<a name="l00268"></a>00268 memset(pwdigest, 0, <span class="keyword">sizeof</span>(pwdigest));
<a name="l00269"></a>00269 memset(prefixedhash, 0, <span class="keyword">sizeof</span>(prefixedhash));
<a name="l00270"></a>00270
<a name="l00271"></a>00271 Data send(&packet, size);
<a name="l00272"></a>00272 RawSend(send);
<a name="l00273"></a>00273 RawReceive(receive);
<a name="l00274"></a>00274
<a name="l00275"></a>00275 <span class="comment">// blank password hash as we don't need this anymore either</span>
<a name="l00276"></a>00276 memset(packet.u.socket.u.password.u.hash, 0,
<a name="l00277"></a>00277 <span class="keyword">sizeof</span>(packet.u.socket.u.password.u.hash));
<a name="l00278"></a>00278 send.Zap();
<a name="l00279"></a>00279
<a name="l00280"></a>00280 <span class="comment">// check sequence ID</span>
<a name="l00281"></a>00281 Protocol::CheckSize(receive, SB_PACKET_HEADER_SIZE);
<a name="l00282"></a>00282 <span class="keywordflow">if</span>( IS_COMMAND(receive, SB_COMMAND_SEQUENCE_HANDSHAKE) ) {
<a name="l00283"></a>00283 CheckSequence(0, receive);
<a name="l00284"></a>00284
<a name="l00285"></a>00285 <span class="comment">// still need our ACK</span>
<a name="l00286"></a>00286 RawReceive(receive);
<a name="l00287"></a>00287 }
<a name="l00288"></a>00288
<a name="l00289"></a>00289 <span class="comment">// receive now holds the Password response</span>
<a name="l00290"></a>00290 }
<a name="l00291"></a>00291
<a name="l00292"></a>00292 <span class="keywordtype">void</span> SocketZero::RawSend(Data &send, <span class="keywordtype">int</span> timeout)
<a name="l00293"></a>00293 {
<a name="l00294"></a>00294 Usb::Device *dev = m_queue ? m_queue->GetUsbDevice() : m_dev;
<a name="l00295"></a>00295 <span class="keywordflow">if</span>( !dev )
<a name="l00296"></a>00296 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"SocketZero: No device available for RawSend"</span>);
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="comment">// Special case: it seems that sending packets with a size that's an</span>
<a name="l00299"></a>00299 <span class="comment">// exact multiple of 0x40 causes the device to get confused.</span>
<a name="l00300"></a>00300 <span class="comment">//</span>
<a name="l00301"></a>00301 <span class="comment">// To get around that, it is observed in the captures that the size</span>
<a name="l00302"></a>00302 <span class="comment">// is sent in a special 3 byte packet before the real packet.</span>
<a name="l00303"></a>00303 <span class="comment">// Check for this case here.</span>
<a name="l00304"></a>00304 <span class="comment">//</span>
<a name="l00305"></a>00305 <span class="keywordflow">if</span>( (send.GetSize() % 0x40) == 0 ) {
<a name="l00306"></a>00306 Protocol::SizePacket packet;
<a name="l00307"></a>00307 packet.size = htobs(send.GetSize());
<a name="l00308"></a>00308 packet.buffer[2] = 0; <span class="comment">// zero the top byte</span>
<a name="l00309"></a>00309 Data sizeCommand(&packet, 3);
<a name="l00310"></a>00310
<a name="l00311"></a>00311 dev->BulkWrite(m_writeEp, sizeCommand, timeout);
<a name="l00312"></a>00312 }
<a name="l00313"></a>00313
<a name="l00314"></a>00314 dev->BulkWrite(m_writeEp, send, timeout);
<a name="l00315"></a>00315 }
<a name="l00316"></a>00316
<a name="l00317"></a>00317 <span class="keywordtype">void</span> SocketZero::RawReceive(Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00318"></a>00318 {
<a name="l00319"></a>00319 <span class="keywordflow">do</span> {
<a name="l00320"></a>00320 <span class="keywordflow">if</span>( m_queue ) {
<a name="l00321"></a>00321 <span class="keywordflow">if</span>( !m_queue->DefaultRead(receive, timeout) )
<a name="l00322"></a>00322 <span class="keywordflow">throw</span> Timeout(<span class="stringliteral">"SocketZero::RawReceive: queue DefaultRead returned false (likely a timeout)"</span>);
<a name="l00323"></a>00323 }
<a name="l00324"></a>00324 <span class="keywordflow">else</span> {
<a name="l00325"></a>00325 m_dev->BulkRead(m_readEp, receive, timeout);
<a name="l00326"></a>00326 }
<a name="l00327"></a>00327 ddout(<span class="stringliteral">"SocketZero::RawReceive: Endpoint "</span>
<a name="l00328"></a>00328 << (m_queue ? m_queue->GetReadEp() : m_readEp)
<a name="l00329"></a>00329 << <span class="stringliteral">"\nReceived:\n"</span> << receive);
<a name="l00330"></a>00330 } <span class="keywordflow">while</span>( SequencePacket(receive) );
<a name="l00331"></a>00331 }
<a name="l00332"></a>00332
<a name="l00333"></a>00333 <span class="comment">//</span>
<a name="l00334"></a>00334 <span class="comment">// SequencePacket</span>
<a name="l00335"></a>00335 <span class="comment">//</span><span class="comment"></span>
<a name="l00336"></a>00336 <span class="comment">/// Returns true if this is a sequence packet that should be ignored.</span>
<a name="l00337"></a>00337 <span class="comment">/// This function is used in SocketZero::RawReceive() in order</span>
<a name="l00338"></a>00338 <span class="comment">/// to determine whether to keep reading or not. By default,</span>
<a name="l00339"></a>00339 <span class="comment">/// this function checks whether the packet is a sequence packet</span>
<a name="l00340"></a>00340 <span class="comment">/// or not, and returns true if so. Also, if it is a sequence</span>
<a name="l00341"></a>00341 <span class="comment">/// packet, it checks the validity of the sequence number.</span>
<a name="l00342"></a>00342 <span class="comment">///</span>
<a name="l00343"></a>00343 <span class="comment">/// If sequence packets become important in the future, this</span>
<a name="l00344"></a>00344 <span class="comment">/// function could be changed to call a user-defined callback,</span>
<a name="l00345"></a>00345 <span class="comment">/// in order to handle these things out of band.</span>
<a name="l00346"></a>00346 <span class="comment">///</span>
<a name="l00347"></a>00347 <span class="comment"></span><span class="keywordtype">bool</span> SocketZero::SequencePacket(<span class="keyword">const</span> Data &data)
<a name="l00348"></a>00348 {
<a name="l00349"></a>00349 <span class="comment">// Begin -- Test quiet durty :(</span>
<a name="l00350"></a>00350 <span class="keywordflow">if</span> (m_hideSequencePacket == <span class="keyword">false</span>) {
<a name="l00351"></a>00351 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00352"></a>00352 }
<a name="l00353"></a>00353 <span class="comment">// End -- Test quiet durty :(</span>
<a name="l00354"></a>00354
<a name="l00355"></a>00355 <span class="keywordflow">if</span>( data.GetSize() >= MIN_PACKET_SIZE ) {
<a name="l00356"></a>00356 MAKE_PACKET(rpack, data);
<a name="l00357"></a>00357 <span class="keywordflow">if</span>( rpack->socket == 0 &&
<a name="l00358"></a>00358 rpack->command == SB_COMMAND_SEQUENCE_HANDSHAKE )
<a name="l00359"></a>00359 {
<a name="l00360"></a>00360 CheckSequence(0, data);
<a name="l00361"></a>00361 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00362"></a>00362 }
<a name="l00363"></a>00363 }
<a name="l00364"></a>00364 <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// not a sequence packet</span>
<a name="l00365"></a>00365 }
<a name="l00366"></a>00366
<a name="l00367"></a>00367 <span class="comment"></span>
<a name="l00368"></a>00368 <span class="comment">///////////////////////////////////////</span>
<a name="l00369"></a>00369 <span class="comment"></span><span class="comment">// SocketZero public API</span>
<a name="l00370"></a>00370
<a name="l00371"></a>00371 <span class="keywordtype">void</span> SocketZero::SetRoutingQueue(SocketRoutingQueue &queue)
<a name="l00372"></a>00372 {
<a name="l00373"></a>00373 <span class="comment">// replace the current queue pointer</span>
<a name="l00374"></a>00374 m_queue = &queue;
<a name="l00375"></a>00375 }
<a name="l00376"></a>00376
<a name="l00377"></a>00377 <span class="keywordtype">void</span> SocketZero::UnlinkRoutingQueue()
<a name="l00378"></a>00378 {
<a name="l00379"></a>00379 m_queue = 0;
<a name="l00380"></a>00380 }
<a name="l00381"></a>00381
<a name="l00382"></a>00382 <span class="keywordtype">void</span> SocketZero::Send(Data &send, <span class="keywordtype">int</span> timeout)
<a name="l00383"></a>00383 {
<a name="l00384"></a>00384 <span class="comment">// force the socket number to 0</span>
<a name="l00385"></a>00385 <span class="keywordflow">if</span>( send.GetSize() >= SB_SOCKET_PACKET_HEADER_SIZE ) {
<a name="l00386"></a>00386 MAKE_PACKETPTR_BUF(spack, send.GetBuffer());
<a name="l00387"></a>00387 spack->socket = 0;
<a name="l00388"></a>00388 }
<a name="l00389"></a>00389
<a name="l00390"></a>00390 <span class="comment">// This is a socket 0 packet, so force the send packet data's</span>
<a name="l00391"></a>00391 <span class="comment">// socket 0 sequence number to something correct.</span>
<a name="l00392"></a>00392 <span class="keywordflow">if</span>( send.GetSize() >= SB_SOCKET_PACKET_HEADER_SIZE ) {
<a name="l00393"></a>00393 MAKE_PACKETPTR_BUF(spack, send.GetBuffer());
<a name="l00394"></a>00394 spack->u.socket.sequence = m_zeroSocketSequence;
<a name="l00395"></a>00395 m_zeroSocketSequence++;
<a name="l00396"></a>00396 }
<a name="l00397"></a>00397
<a name="l00398"></a>00398 RawSend(send, timeout);
<a name="l00399"></a>00399 }
<a name="l00400"></a>00400
<a name="l00401"></a>00401 <span class="keywordtype">void</span> SocketZero::Send(Data &send, Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00402"></a>00402 {
<a name="l00403"></a>00403 Send(send, timeout);
<a name="l00404"></a>00404 RawReceive(receive, timeout);
<a name="l00405"></a>00405 }
<a name="l00406"></a>00406
<a name="l00407"></a>00407 <span class="keywordtype">void</span> SocketZero::Send(Barry::Packet &packet, <span class="keywordtype">int</span> timeout)
<a name="l00408"></a>00408 {
<a name="l00409"></a>00409 Send(packet.m_send, *packet.m_receive, timeout);
<a name="l00410"></a>00410 }
<a name="l00411"></a>00411
<a name="l00412"></a>00412 <span class="keywordtype">void</span> SocketZero::Receive(Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00413"></a>00413 {
<a name="l00414"></a>00414 RawReceive(receive, timeout);
<a name="l00415"></a>00415 }
<a name="l00416"></a>00416
<a name="l00417"></a>00417
<a name="l00418"></a>00418 <span class="comment">//</span>
<a name="l00419"></a>00419 <span class="comment">// Open</span>
<a name="l00420"></a>00420 <span class="comment">//</span><span class="comment"></span>
<a name="l00421"></a>00421 <span class="comment">/// Open a logical socket on the device.</span>
<a name="l00422"></a>00422 <span class="comment">///</span>
<a name="l00423"></a>00423 <span class="comment">/// Both the socket number and the flag are based on the response to the</span>
<a name="l00424"></a>00424 <span class="comment">/// SELECT_MODE command. See Controller::SelectMode() for more info</span>
<a name="l00425"></a>00425 <span class="comment">/// on this.</span>
<a name="l00426"></a>00426 <span class="comment">///</span>
<a name="l00427"></a>00427 <span class="comment">/// The packet sequence is normal for most socket operations.</span>
<a name="l00428"></a>00428 <span class="comment">///</span>
<a name="l00429"></a>00429 <span class="comment">/// - Down: command packet with OPEN_SOCKET</span>
<a name="l00430"></a>00430 <span class="comment">/// - Up: optional sequence handshake packet</span>
<a name="l00431"></a>00431 <span class="comment">/// - Up: command response, which repeats the socket and flag data</span>
<a name="l00432"></a>00432 <span class="comment">/// as confirmation</span>
<a name="l00433"></a>00433 <span class="comment">///</span>
<a name="l00434"></a>00434 <span class="comment">/// \exception Barry::Error</span>
<a name="l00435"></a>00435 <span class="comment">/// Thrown on protocol error.</span>
<a name="l00436"></a>00436 <span class="comment">///</span>
<a name="l00437"></a>00437 <span class="comment">/// \exception Barry::BadPassword</span>
<a name="l00438"></a>00438 <span class="comment">/// Thrown on invalid password, or not enough retries left</span>
<a name="l00439"></a>00439 <span class="comment">/// on device.</span>
<a name="l00440"></a>00440 <span class="comment">///</span>
<a name="l00441"></a>00441 <span class="comment"></span>SocketHandle SocketZero::Open(uint16_t socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00442"></a>00442 {
<a name="l00443"></a>00443 <span class="comment">// Things get a little funky here, as we may be left in an</span>
<a name="l00444"></a>00444 <span class="comment">// intermediate state in the case of a failed password.</span>
<a name="l00445"></a>00445 <span class="comment">// This function should support being called as many times</span>
<a name="l00446"></a>00446 <span class="comment">// as needed to handle the password</span>
<a name="l00447"></a>00447
<a name="l00448"></a>00448 Data send, receive;
<a name="l00449"></a>00449 ZeroPacket packet(send, receive);
<a name="l00450"></a>00450
<a name="l00451"></a>00451 <span class="comment">// save sequence for later close</span>
<a name="l00452"></a>00452 uint8_t closeFlag = GetZeroSocketSequence();
<a name="l00453"></a>00453
<a name="l00454"></a>00454 <span class="keywordflow">if</span>( !m_halfOpen ) {
<a name="l00455"></a>00455 <span class="comment">// starting fresh</span>
<a name="l00456"></a>00456 m_remainingTries = 0;
<a name="l00457"></a>00457
<a name="l00458"></a>00458 SendOpen(socket, receive);
<a name="l00459"></a>00459
<a name="l00460"></a>00460 <span class="comment">// check for password challenge, or success</span>
<a name="l00461"></a>00461 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_PASSWORD_CHALLENGE ) {
<a name="l00462"></a>00462 m_halfOpen = <span class="keyword">true</span>;
<a name="l00463"></a>00463 m_challengeSeed = packet.ChallengeSeed();
<a name="l00464"></a>00464 m_remainingTries = packet.RemainingTries();
<a name="l00465"></a>00465 }
<a name="l00466"></a>00466
<a name="l00467"></a>00467 <span class="comment">// fall through to challenge code...</span>
<a name="l00468"></a>00468 }
<a name="l00469"></a>00469
<a name="l00470"></a>00470 <span class="keywordflow">if</span>( m_halfOpen ) {
<a name="l00471"></a>00471 <span class="comment">// half open, device is expecting a password hash... do we</span>
<a name="l00472"></a>00472 <span class="comment">// have a password?</span>
<a name="l00473"></a>00473 <span class="keywordflow">if</span>( !password ) {
<a name="l00474"></a>00474 <span class="keywordflow">throw</span> BadPassword(<span class="stringliteral">"No password specified."</span>, m_remainingTries, <span class="keyword">false</span>);
<a name="l00475"></a>00475 }
<a name="l00476"></a>00476
<a name="l00477"></a>00477 <span class="comment">// only allow password attempts if there are</span>
<a name="l00478"></a>00478 <span class="comment">// BARRY_MIN_PASSWORD_TRIES or more tries remaining...</span>
<a name="l00479"></a>00479 <span class="comment">// we want to give the user at least some chance on a</span>
<a name="l00480"></a>00480 <span class="comment">// Windows machine before the device commits suicide.</span>
<a name="l00481"></a>00481 <span class="keywordflow">if</span>( m_remainingTries < BARRY_MIN_PASSWORD_TRIES ) {
<a name="l00482"></a>00482 <span class="keywordflow">throw</span> BadPassword(<span class="stringliteral">"Fewer than "</span> BARRY_MIN_PASSWORD_TRIES_ASC <span class="stringliteral">" password tries remaining in device. Refusing to proceed, to avoid device zapping itself. Use a Windows client, or re-cradle the device."</span>,
<a name="l00483"></a>00483 m_remainingTries,
<a name="l00484"></a>00484 <span class="keyword">true</span>);
<a name="l00485"></a>00485 }
<a name="l00486"></a>00486
<a name="l00487"></a>00487 <span class="comment">// save sequence for later close (again after SendOpen())</span>
<a name="l00488"></a>00488 closeFlag = GetZeroSocketSequence();
<a name="l00489"></a>00489
<a name="l00490"></a>00490 SendPasswordHash(socket, password, receive);
<a name="l00491"></a>00491
<a name="l00492"></a>00492 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_PASSWORD_FAILED ) {
<a name="l00493"></a>00493 m_halfOpen = <span class="keyword">true</span>;
<a name="l00494"></a>00494 m_challengeSeed = packet.ChallengeSeed();
<a name="l00495"></a>00495 m_remainingTries = packet.RemainingTries();
<a name="l00496"></a>00496 <span class="keywordflow">throw</span> BadPassword(<span class="stringliteral">"Password rejected by device."</span>, m_remainingTries, <span class="keyword">false</span>);
<a name="l00497"></a>00497 }
<a name="l00498"></a>00498
<a name="l00499"></a>00499 <span class="comment">// if we get this far, we are no longer in half-open password</span>
<a name="l00500"></a>00500 <span class="comment">// mode, so we can reset our flags</span>
<a name="l00501"></a>00501 m_halfOpen = <span class="keyword">false</span>;
<a name="l00502"></a>00502
<a name="l00503"></a>00503 <span class="comment">// fall through to success check...</span>
<a name="l00504"></a>00504 }
<a name="l00505"></a>00505
<a name="l00506"></a>00506 <span class="comment">// If the device thinks that the socket was already open then</span>
<a name="l00507"></a>00507 <span class="comment">// it will tell us by sending an SB_COMMAND_CLOSE_SOCKET.</span>
<a name="l00508"></a>00508 <span class="comment">//</span>
<a name="l00509"></a>00509 <span class="comment">// This happens most commonly when using raw channels which</span>
<a name="l00510"></a>00510 <span class="comment">// haven't been cleanly closed (such as by killing the process</span>
<a name="l00511"></a>00511 <span class="comment">// running Barry) and so the device still thinks the socket</span>
<a name="l00512"></a>00512 <span class="comment">// is open.</span>
<a name="l00513"></a>00513 <span class="comment">//</span>
<a name="l00514"></a>00514 <span class="comment">// Retrying the open will usually succeed, but relies on the</span>
<a name="l00515"></a>00515 <span class="comment">// device software re-creating the channel after it's closed</span>
<a name="l00516"></a>00516 <span class="comment">// so return an error here instead of automatically retrying.</span>
<a name="l00517"></a>00517 <span class="keywordflow">if</span>( packet.Command() == SB_COMMAND_CLOSE_SOCKET )
<a name="l00518"></a>00518 {
<a name="l00519"></a>00519 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: Device closed socket when trying to open"</span>);
<a name="l00520"></a>00520 }
<a name="l00521"></a>00521
<a name="l00522"></a>00522 <span class="keywordflow">if</span>( packet.Command() != SB_COMMAND_OPENED_SOCKET ||
<a name="l00523"></a>00523 packet.SocketResponse() != socket ||
<a name="l00524"></a>00524 packet.SocketSequence() != closeFlag )
<a name="l00525"></a>00525 {
<a name="l00526"></a>00526 eout(<span class="stringliteral">"Packet:\n"</span> << receive);
<a name="l00527"></a>00527 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: Bad OPENED packet in Open"</span>);
<a name="l00528"></a>00528 }
<a name="l00529"></a>00529
<a name="l00530"></a>00530 <span class="comment">// success! save the socket</span>
<a name="l00531"></a>00531 <span class="keywordflow">return</span> SocketHandle(<span class="keyword">new</span> Socket(*<span class="keyword">this</span>, socket, closeFlag));
<a name="l00532"></a>00532 }
<a name="l00533"></a>00533
<a name="l00534"></a>00534 <span class="comment">//</span>
<a name="l00535"></a>00535 <span class="comment">// Close</span>
<a name="l00536"></a>00536 <span class="comment">//</span><span class="comment"></span>
<a name="l00537"></a>00537 <span class="comment">/// Closes a non-default socket (i.e. non-zero socket number)</span>
<a name="l00538"></a>00538 <span class="comment">///</span>
<a name="l00539"></a>00539 <span class="comment">/// The packet sequence is just like Open(), except the command is</span>
<a name="l00540"></a>00540 <span class="comment">/// CLOSE_SOCKET.</span>
<a name="l00541"></a>00541 <span class="comment">///</span>
<a name="l00542"></a>00542 <span class="comment">/// \exception Barry::Error</span>
<a name="l00543"></a>00543 <span class="comment">///</span>
<a name="l00544"></a>00544 <span class="comment"></span><span class="keywordtype">void</span> SocketZero::Close(Socket &socket)
<a name="l00545"></a>00545 {
<a name="l00546"></a>00546 <span class="keywordflow">if</span>( socket.GetSocket() == 0 )
<a name="l00547"></a>00547 <span class="keywordflow">return</span>; <span class="comment">// nothing to do</span>
<a name="l00548"></a>00548
<a name="l00549"></a>00549 <span class="comment">// build close command</span>
<a name="l00550"></a>00550 Barry::Protocol::Packet packet;
<a name="l00551"></a>00551 packet.socket = 0;
<a name="l00552"></a>00552 packet.size = htobs(SB_SOCKET_PACKET_HEADER_SIZE);
<a name="l00553"></a>00553 packet.command = SB_COMMAND_CLOSE_SOCKET;
<a name="l00554"></a>00554 packet.u.socket.socket = htobs(socket.GetSocket());
<a name="l00555"></a>00555 packet.u.socket.sequence = socket.GetCloseFlag();
<a name="l00556"></a>00556
<a name="l00557"></a>00557 Data command(&packet, SB_SOCKET_PACKET_HEADER_SIZE);
<a name="l00558"></a>00558 Data response;
<a name="l00559"></a>00559 <span class="keywordflow">try</span> {
<a name="l00560"></a>00560 Send(command, response);
<a name="l00561"></a>00561 }
<a name="l00562"></a>00562 <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="l00563"></a>00563 <span class="comment">// reset so this won't be called again</span>
<a name="l00564"></a>00564 socket.ForceClosed();
<a name="l00565"></a>00565
<a name="l00566"></a>00566 eeout(command, response);
<a name="l00567"></a>00567 <span class="keywordflow">throw</span>;
<a name="l00568"></a>00568 }
<a name="l00569"></a>00569
<a name="l00570"></a>00570 <span class="comment">// starting fresh, reset sequence ID</span>
<a name="l00571"></a>00571 Protocol::CheckSize(response, SB_PACKET_HEADER_SIZE);
<a name="l00572"></a>00572 <span class="keywordflow">if</span>( IS_COMMAND(response, SB_COMMAND_SEQUENCE_HANDSHAKE) ) {
<a name="l00573"></a>00573 CheckSequence(0, response);
<a name="l00574"></a>00574
<a name="l00575"></a>00575 <span class="comment">// still need our ACK</span>
<a name="l00576"></a>00576 RawReceive(response);
<a name="l00577"></a>00577 }
<a name="l00578"></a>00578
<a name="l00579"></a>00579 Protocol::CheckSize(response, SB_SOCKET_PACKET_HEADER_SIZE);
<a name="l00580"></a>00580 MAKE_PACKET(rpack, response);
<a name="l00581"></a>00581 <span class="comment">// The reply will be SB_COMMAND_CLOSED_SOCKET if the device</span>
<a name="l00582"></a>00582 <span class="comment">// has closed the socket in response to our request.</span>
<a name="l00583"></a>00583 <span class="comment">//</span>
<a name="l00584"></a>00584 <span class="comment">// It's also possible for the reply to be</span>
<a name="l00585"></a>00585 <span class="comment">// SB_COMMAND_REMOTE_CLOSE_SOCKET if the device wanted to</span>
<a name="l00586"></a>00586 <span class="comment">// close the socket at the same time, such as if the channel</span>
<a name="l00587"></a>00587 <span class="comment">// API is being used by the device.</span>
<a name="l00588"></a>00588 <span class="keywordflow">if</span>( ( rpack->command != SB_COMMAND_CLOSED_SOCKET &&
<a name="l00589"></a>00589 rpack->command != SB_COMMAND_REMOTE_CLOSE_SOCKET ) ||
<a name="l00590"></a>00590 btohs(rpack->u.socket.socket) != socket.GetSocket() ||
<a name="l00591"></a>00591 rpack->u.socket.sequence != socket.GetCloseFlag() )
<a name="l00592"></a>00592 {
<a name="l00593"></a>00593 <span class="comment">// reset so this won't be called again</span>
<a name="l00594"></a>00594 socket.ForceClosed();
<a name="l00595"></a>00595
<a name="l00596"></a>00596 eout(<span class="stringliteral">"Packet:\n"</span> << response);
<a name="l00597"></a>00597 <span class="keywordflow">throw</span> BadPacket(rpack->command, <span class="stringliteral">"Socket: Bad CLOSED packet in Close"</span>);
<a name="l00598"></a>00598 }
<a name="l00599"></a>00599
<a name="l00600"></a>00600 <span class="keywordflow">if</span>( m_resetOnClose ) {
<a name="l00601"></a>00601 Data send, receive;
<a name="l00602"></a>00602 ZeroPacket reset_packet(send, receive);
<a name="l00603"></a>00603 reset_packet.Reset();
<a name="l00604"></a>00604
<a name="l00605"></a>00605 Send(reset_packet);
<a name="l00606"></a>00606 <span class="keywordflow">if</span>( reset_packet.CommandResponse() != SB_COMMAND_RESET_REPLY ) {
<a name="l00607"></a>00607 <span class="keywordflow">throw</span> BadPacket(reset_packet.CommandResponse(),
<a name="l00608"></a>00608 <span class="stringliteral">"Socket: Missing RESET_REPLY in Close"</span>);
<a name="l00609"></a>00609 }
<a name="l00610"></a>00610 }
<a name="l00611"></a>00611
<a name="l00612"></a>00612 <span class="comment">// // and finally, there always seems to be an extra read of</span>
<a name="l00613"></a>00613 <span class="comment">// // an empty packet at the end... just throw it away</span>
<a name="l00614"></a>00614 <span class="comment">// try {</span>
<a name="l00615"></a>00615 <span class="comment">// RawReceive(response, 1);</span>
<a name="l00616"></a>00616 <span class="comment">// }</span>
<a name="l00617"></a>00617 <span class="comment">// catch( Usb::Timeout & ) {</span>
<a name="l00618"></a>00618 <span class="comment">// }</span>
<a name="l00619"></a>00619
<a name="l00620"></a>00620 <span class="comment">// reset socket and flag</span>
<a name="l00621"></a>00621 socket.ForceClosed();
<a name="l00622"></a>00622 }
<a name="l00623"></a>00623
<a name="l00624"></a>00624 <span class="comment">//</span>
<a name="l00625"></a>00625 <span class="comment">// ClearHalt</span>
<a name="l00626"></a>00626 <span class="comment">//</span><span class="comment"></span>
<a name="l00627"></a>00627 <span class="comment">/// Clears the USB Halt bit on both the read and write endpoints</span>
<a name="l00628"></a>00628 <span class="comment">///</span>
<a name="l00629"></a>00629 <span class="comment"></span><span class="keywordtype">void</span> SocketZero::ClearHalt()
<a name="l00630"></a>00630 {
<a name="l00631"></a>00631 Usb::Device *dev = m_queue ? m_queue->GetUsbDevice() : m_dev;
<a name="l00632"></a>00632 <span class="keywordflow">if</span>( !dev )
<a name="l00633"></a>00633 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"SocketZero: No device available for ClearHalt"</span>);
<a name="l00634"></a>00634
<a name="l00635"></a>00635 <span class="comment">// clear the read endpoint</span>
<a name="l00636"></a>00636 <span class="keywordflow">if</span>( m_queue ) {
<a name="l00637"></a>00637 dev->ClearHalt(m_queue->GetReadEp());
<a name="l00638"></a>00638 }
<a name="l00639"></a>00639 <span class="keywordflow">else</span> {
<a name="l00640"></a>00640 dev->ClearHalt(m_readEp);
<a name="l00641"></a>00641 }
<a name="l00642"></a>00642
<a name="l00643"></a>00643 <span class="comment">// clear the write endpoint</span>
<a name="l00644"></a>00644 dev->ClearHalt(m_writeEp);
<a name="l00645"></a>00645 }
<a name="l00646"></a>00646
<a name="l00647"></a>00647
<a name="l00648"></a>00648
<a name="l00649"></a>00649
<a name="l00650"></a>00650
<a name="l00651"></a>00651 <span class="comment"></span>
<a name="l00652"></a>00652 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00653"></a>00653 <span class="comment"></span><span class="comment">// Socket class</span>
<a name="l00654"></a>00654
<a name="l00655"></a>00655 Socket::Socket( SocketZero &zero,
<a name="l00656"></a>00656 uint16_t socket,
<a name="l00657"></a>00657 uint8_t closeFlag)
<a name="l00658"></a>00658 : m_zero(&zero)
<a name="l00659"></a>00659 , m_socket(socket)
<a name="l00660"></a>00660 , m_closeFlag(closeFlag)
<a name="l00661"></a>00661 , m_registered(false)
<a name="l00662"></a>00662 {
<a name="l00663"></a>00663 }
<a name="l00664"></a>00664
<a name="l00665"></a>00665 Socket::~Socket()
<a name="l00666"></a>00666 {
<a name="l00667"></a>00667 <span class="comment">// trap exceptions in the destructor</span>
<a name="l00668"></a>00668 <span class="keywordflow">try</span> {
<a name="l00669"></a>00669 <span class="comment">// a non-default socket has been opened, close it</span>
<a name="l00670"></a>00670 Close();
<a name="l00671"></a>00671 }
<a name="l00672"></a>00672 <span class="keywordflow">catch</span>( std::runtime_error &re ) {
<a name="l00673"></a>00673 <span class="comment">// do nothing... log it?</span>
<a name="l00674"></a>00674 dout(<span class="stringliteral">"Exception caught in ~Socket: "</span> << re.what());
<a name="l00675"></a>00675 }
<a name="l00676"></a>00676 }
<a name="l00677"></a>00677
<a name="l00678"></a>00678 <span class="comment"></span>
<a name="l00679"></a>00679 <span class="comment">////////////////////////////////////</span>
<a name="l00680"></a>00680 <span class="comment"></span><span class="comment">// Socket protected API</span>
<a name="l00681"></a>00681
<a name="l00682"></a>00682 <span class="keywordtype">void</span> Socket::CheckSequence(<span class="keyword">const</span> Data &seq)
<a name="l00683"></a>00683 {
<a name="l00684"></a>00684 m_zero->CheckSequence(m_socket, seq);
<a name="l00685"></a>00685 }
<a name="l00686"></a>00686
<a name="l00687"></a>00687 <span class="keywordtype">void</span> Socket::ForceClosed()
<a name="l00688"></a>00688 {
<a name="l00689"></a>00689 m_socket = 0;
<a name="l00690"></a>00690 m_closeFlag = 0;
<a name="l00691"></a>00691 }
<a name="l00692"></a>00692
<a name="l00693"></a>00693 <span class="comment"></span>
<a name="l00694"></a>00694 <span class="comment">////////////////////////////////////</span>
<a name="l00695"></a>00695 <span class="comment"></span><span class="comment">// Socket public API</span>
<a name="l00696"></a>00696
<a name="l00697"></a>00697 <span class="keywordtype">void</span> Socket::Close()
<a name="l00698"></a>00698 {
<a name="l00699"></a>00699 UnregisterInterest();
<a name="l00700"></a>00700 m_zero->Close(*<span class="keyword">this</span>);
<a name="l00701"></a>00701 }
<a name="l00702"></a>00702
<a name="l00703"></a>00703
<a name="l00704"></a>00704 <span class="comment">//</span>
<a name="l00705"></a>00705 <span class="comment">// Send</span>
<a name="l00706"></a>00706 <span class="comment">//</span><span class="comment"></span>
<a name="l00707"></a>00707 <span class="comment">/// Sends 'send' data to device, no receive.</span>
<a name="l00708"></a>00708 <span class="comment">///</span>
<a name="l00709"></a>00709 <span class="comment">/// \returns void</span>
<a name="l00710"></a>00710 <span class="comment">///</span>
<a name="l00711"></a>00711 <span class="comment">/// \exception Usb::Error on underlying bus errors.</span>
<a name="l00712"></a>00712 <span class="comment">///</span>
<a name="l00713"></a><a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50">00713</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Socket::Send</a>(Data &send, <span class="keywordtype">int</span> timeout)
<a name="l00714"></a>00714 {
<a name="l00715"></a>00715 <span class="comment">// force the socket number to this socket</span>
<a name="l00716"></a>00716 <span class="keywordflow">if</span>( send.GetSize() >= SB_PACKET_HEADER_SIZE ) {
<a name="l00717"></a>00717 MAKE_PACKETPTR_BUF(spack, send.GetBuffer());
<a name="l00718"></a>00718 spack->socket = htobs(m_socket);
<a name="l00719"></a>00719 }
<a name="l00720"></a>00720 m_zero->RawSend(send, timeout);
<a name="l00721"></a>00721 }
<a name="l00722"></a>00722
<a name="l00723"></a>00723 <span class="comment">//</span>
<a name="l00724"></a>00724 <span class="comment">// Send</span>
<a name="l00725"></a>00725 <span class="comment">//</span><span class="comment"></span>
<a name="l00726"></a>00726 <span class="comment">/// Sends 'send' data to device, and waits for response.</span>
<a name="l00727"></a>00727 <span class="comment">///</span>
<a name="l00728"></a>00728 <span class="comment">/// \returns void</span>
<a name="l00729"></a>00729 <span class="comment">///</span>
<a name="l00730"></a>00730 <span class="comment">/// \exception Usb::Error on underlying bus errors.</span>
<a name="l00731"></a>00731 <span class="comment">///</span>
<a name="l00732"></a><a class="code" href="classBarry_1_1Socket.html#0bfdaaf739cc692d96d73a8781197423">00732</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Socket::Send</a>(Data &send, Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00733"></a>00733 {
<a name="l00734"></a>00734 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(send, timeout);
<a name="l00735"></a>00735 Receive(receive, timeout);
<a name="l00736"></a>00736 }
<a name="l00737"></a>00737
<a name="l00738"></a>00738 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Socket::Send</a>(Barry::Packet &packet, <span class="keywordtype">int</span> timeout)
<a name="l00739"></a>00739 {
<a name="l00740"></a>00740 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(packet.m_send, *packet.m_receive, timeout);
<a name="l00741"></a>00741 }
<a name="l00742"></a>00742
<a name="l00743"></a>00743 <span class="keywordtype">void</span> Socket::Receive(Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00744"></a>00744 {
<a name="l00745"></a>00745 <span class="keywordflow">if</span>( m_registered ) {
<a name="l00746"></a>00746 <span class="keywordflow">if</span>( m_zero->m_queue ) {
<a name="l00747"></a>00747 <span class="keywordflow">if</span>( !m_zero->m_queue->SocketRead(m_socket, receive, timeout) )
<a name="l00748"></a>00748 <span class="keywordflow">throw</span> Timeout(<span class="stringliteral">"Socket::Receive: queue SocketRead returned false (likely a timeout)"</span>);
<a name="l00749"></a>00749 }
<a name="l00750"></a>00750 <span class="keywordflow">else</span> {
<a name="l00751"></a>00751 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"NULL queue pointer in a registered socket read."</span>);
<a name="l00752"></a>00752 }
<a name="l00753"></a>00753 }
<a name="l00754"></a>00754 <span class="keywordflow">else</span> {
<a name="l00755"></a>00755 m_zero->RawReceive(receive, timeout);
<a name="l00756"></a>00756 }
<a name="l00757"></a>00757 }
<a name="l00758"></a>00758
<a name="l00759"></a>00759
<a name="l00760"></a>00760 <span class="comment">// FIXME - find a better way to do this?</span>
<a name="l00761"></a>00761 <span class="keywordtype">void</span> Socket::ReceiveData(Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00762"></a>00762 {
<a name="l00763"></a>00763 HideSequencePacket(<span class="keyword">false</span>);
<a name="l00764"></a>00764 Receive(receive);
<a name="l00765"></a>00765 HideSequencePacket(<span class="keyword">true</span>);
<a name="l00766"></a>00766 }
<a name="l00767"></a>00767
<a name="l00768"></a>00768 <span class="keywordtype">void</span> Socket::ClearHalt()
<a name="l00769"></a>00769 {
<a name="l00770"></a>00770 m_zero->ClearHalt();
<a name="l00771"></a>00771 }
<a name="l00772"></a>00772
<a name="l00773"></a>00773
<a name="l00774"></a>00774 <span class="comment">// FIXME - find a better way to do this?</span>
<a name="l00775"></a>00775 <span class="keywordtype">void</span> Socket::InitSequence(<span class="keywordtype">int</span> timeout)
<a name="l00776"></a>00776 {
<a name="l00777"></a>00777 Data receive;
<a name="l00778"></a>00778 receive.Zap();
<a name="l00779"></a>00779
<a name="l00780"></a>00780 HideSequencePacket(<span class="keyword">false</span>);
<a name="l00781"></a>00781 Receive(receive);
<a name="l00782"></a>00782 HideSequencePacket(<span class="keyword">true</span>);
<a name="l00783"></a>00783
<a name="l00784"></a>00784 Protocol::CheckSize(receive, SB_PACKET_HEADER_SIZE);
<a name="l00785"></a>00785 CheckSequence(receive);
<a name="l00786"></a>00786 }
<a name="l00787"></a>00787
<a name="l00788"></a>00788
<a name="l00789"></a>00789 <span class="comment">// sends the send packet down to the device</span>
<a name="l00790"></a>00790 <span class="comment">// Blocks until response received or timed out in Usb::Device</span>
<a name="l00791"></a>00791 <span class="comment">//</span>
<a name="l00792"></a>00792 <span class="comment">// This function is used to send packet to JVM</span>
<a name="l00793"></a>00793 <span class="keywordtype">void</span> Socket::PacketJVM(Data &send, Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00794"></a>00794 {
<a name="l00795"></a>00795 <span class="keywordflow">if</span>( ( send.GetSize() < MIN_PACKET_DATA_SIZE ) ||
<a name="l00796"></a>00796 ( send.GetSize() > MAX_PACKET_DATA_SIZE ) ) {
<a name="l00797"></a>00797 <span class="comment">// we don't do that around here</span>
<a name="l00798"></a>00798 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Socket: unknown send data in PacketJVM()"</span>);
<a name="l00799"></a>00799 }
<a name="l00800"></a>00800
<a name="l00801"></a>00801 Data &inFrag = receive;
<a name="l00802"></a>00802 receive.Zap();
<a name="l00803"></a>00803
<a name="l00804"></a>00804 <span class="comment">// send non-fragmented</span>
<a name="l00805"></a>00805 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(send, inFrag, timeout);
<a name="l00806"></a>00806
<a name="l00807"></a>00807 <span class="keywordtype">bool</span> done = <span class="keyword">false</span>;
<a name="l00808"></a>00808 <span class="keywordtype">int</span> blankCount = 0;
<a name="l00809"></a>00809
<a name="l00810"></a>00810 <span class="keywordflow">while</span>( !done ) {
<a name="l00811"></a>00811 <span class="comment">// check the packet's validity</span>
<a name="l00812"></a>00812 <span class="keywordflow">if</span>( inFrag.GetSize() > 6 ) {
<a name="l00813"></a>00813 MAKE_PACKET(rpack, inFrag);
<a name="l00814"></a>00814
<a name="l00815"></a>00815 blankCount = 0;
<a name="l00816"></a>00816
<a name="l00817"></a>00817 Protocol::CheckSize(inFrag, SB_PACKET_HEADER_SIZE);
<a name="l00818"></a>00818
<a name="l00819"></a>00819 <span class="keywordflow">switch</span>( rpack->command )
<a name="l00820"></a>00820 {
<a name="l00821"></a>00821 <span class="keywordflow">case</span> SB_COMMAND_SEQUENCE_HANDSHAKE:
<a name="l00822"></a>00822 CheckSequence(inFrag);
<a name="l00823"></a>00823 <span class="keywordflow">break</span>;
<a name="l00824"></a>00824
<a name="l00825"></a>00825 <span class="keywordflow">default</span>: {
<a name="l00826"></a>00826 std::ostringstream oss;
<a name="l00827"></a>00827 oss << <span class="stringliteral">"Socket: (read) unhandled packet in Packet(): 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int)rpack->command;
<a name="l00828"></a>00828 eout(oss.str());
<a name="l00829"></a>00829 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(oss.str());
<a name="l00830"></a>00830 }
<a name="l00831"></a>00831 <span class="keywordflow">break</span>;
<a name="l00832"></a>00832 }
<a name="l00833"></a>00833 }
<a name="l00834"></a>00834 <span class="keywordflow">else</span> <span class="keywordflow">if</span>( inFrag.GetSize() == 6 ) {
<a name="l00835"></a>00835 done = <span class="keyword">true</span>;
<a name="l00836"></a>00836 }
<a name="l00837"></a>00837 <span class="keywordflow">else</span> {
<a name="l00838"></a>00838 blankCount++;
<a name="l00839"></a>00839
<a name="l00840"></a>00840 <span class="comment">//std::cerr << "Blank! " << blankCount << std::endl;</span>
<a name="l00841"></a>00841 <span class="keywordflow">if</span>( blankCount == 10 ) {
<a name="l00842"></a>00842 <span class="comment">// only ask for more data on stalled sockets</span>
<a name="l00843"></a>00843 <span class="comment">// for so long</span>
<a name="l00844"></a>00844 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: 10 blank packets received"</span>);
<a name="l00845"></a>00845 }
<a name="l00846"></a>00846 }
<a name="l00847"></a>00847
<a name="l00848"></a>00848 <span class="keywordflow">if</span>( !done ) {
<a name="l00849"></a>00849 <span class="comment">// not done yet, ask for another read</span>
<a name="l00850"></a>00850 Receive(inFrag);
<a name="l00851"></a>00851 }
<a name="l00852"></a>00852 }
<a name="l00853"></a>00853 }
<a name="l00854"></a>00854
<a name="l00855"></a>00855 <span class="comment">// sends the send packet down to the device</span>
<a name="l00856"></a>00856 <span class="comment">// Blocks until response received or timed out in Usb::Device</span>
<a name="l00857"></a>00857 <span class="keywordtype">void</span> Socket::PacketData(Data &send, Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00858"></a>00858 {
<a name="l00859"></a>00859 <span class="keywordflow">if</span>( ( send.GetSize() < MIN_PACKET_DATA_SIZE ) ||
<a name="l00860"></a>00860 ( send.GetSize() > MAX_PACKET_DATA_SIZE ) ) {
<a name="l00861"></a>00861 <span class="comment">// we don't do that around here</span>
<a name="l00862"></a>00862 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Socket: unknown send data in PacketData()"</span>);
<a name="l00863"></a>00863 }
<a name="l00864"></a>00864
<a name="l00865"></a>00865 Data &inFrag = receive;
<a name="l00866"></a>00866 receive.Zap();
<a name="l00867"></a>00867
<a name="l00868"></a>00868 <span class="comment">// send non-fragmented</span>
<a name="l00869"></a>00869 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(send, inFrag, timeout);
<a name="l00870"></a>00870
<a name="l00871"></a>00871 <span class="keywordtype">bool</span> done = <span class="keyword">false</span>;
<a name="l00872"></a>00872 <span class="keywordtype">int</span> blankCount = 0;
<a name="l00873"></a>00873
<a name="l00874"></a>00874 <span class="keywordflow">while</span>( !done ) {
<a name="l00875"></a>00875 <span class="comment">// check the packet's validity</span>
<a name="l00876"></a>00876 <span class="keywordflow">if</span>( inFrag.GetSize() > 0 ) {
<a name="l00877"></a>00877 MAKE_PACKET(rpack, inFrag);
<a name="l00878"></a>00878
<a name="l00879"></a>00879 blankCount = 0;
<a name="l00880"></a>00880
<a name="l00881"></a>00881 Protocol::CheckSize(inFrag, SB_PACKET_HEADER_SIZE);
<a name="l00882"></a>00882
<a name="l00883"></a>00883 <span class="keywordflow">switch</span>( rpack->command )
<a name="l00884"></a>00884 {
<a name="l00885"></a>00885 <span class="keywordflow">case</span> SB_COMMAND_SEQUENCE_HANDSHAKE:
<a name="l00886"></a>00886 CheckSequence(inFrag);
<a name="l00887"></a>00887 <span class="keywordflow">if</span> (!m_zero->IsSequencePacketHidden())
<a name="l00888"></a>00888 done = <span class="keyword">true</span>;
<a name="l00889"></a>00889 <span class="keywordflow">break</span>;
<a name="l00890"></a>00890
<a name="l00891"></a>00891 <span class="keywordflow">case</span> SB_COMMAND_JL_READY:
<a name="l00892"></a>00892 <span class="keywordflow">case</span> SB_COMMAND_JL_ACK:
<a name="l00893"></a>00893 <span class="keywordflow">case</span> SB_COMMAND_JL_HELLO_ACK:
<a name="l00894"></a>00894 <span class="keywordflow">case</span> SB_COMMAND_JL_RESET_REQUIRED:
<a name="l00895"></a>00895 done = <span class="keyword">true</span>;
<a name="l00896"></a>00896 <span class="keywordflow">break</span>;
<a name="l00897"></a>00897
<a name="l00898"></a>00898 <span class="keywordflow">case</span> SB_COMMAND_JL_GET_DATA_ENTRY: <span class="comment">// This response means that the next packet is the stream</span>
<a name="l00899"></a>00899 done = <span class="keyword">true</span>;
<a name="l00900"></a>00900 <span class="keywordflow">break</span>;
<a name="l00901"></a>00901
<a name="l00902"></a>00902 <span class="keywordflow">case</span> SB_DATA_JL_INVALID:
<a name="l00903"></a>00903 <span class="keywordflow">throw</span> BadPacket(rpack->command, <span class="stringliteral">"file is not a valid Java code file"</span>);
<a name="l00904"></a>00904 <span class="keywordflow">break</span>;
<a name="l00905"></a>00905
<a name="l00906"></a>00906 <span class="keywordflow">case</span> SB_COMMAND_JL_NOT_SUPPORTED:
<a name="l00907"></a>00907 <span class="keywordflow">throw</span> BadPacket(rpack->command, <span class="stringliteral">"device does not support requested command"</span>);
<a name="l00908"></a>00908 <span class="keywordflow">break</span>;
<a name="l00909"></a>00909
<a name="l00910"></a>00910 <span class="keywordflow">default</span>:
<a name="l00911"></a>00911 <span class="comment">// unknown packet, pass it up to the</span>
<a name="l00912"></a>00912 <span class="comment">// next higher code layer</span>
<a name="l00913"></a>00913 done = <span class="keyword">true</span>;
<a name="l00914"></a>00914 <span class="keywordflow">break</span>;
<a name="l00915"></a>00915 }
<a name="l00916"></a>00916 }
<a name="l00917"></a>00917 <span class="keywordflow">else</span> {
<a name="l00918"></a>00918 blankCount++;
<a name="l00919"></a>00919 <span class="comment">//std::cerr << "Blank! " << blankCount << std::endl;</span>
<a name="l00920"></a>00920 <span class="keywordflow">if</span>( blankCount == 10 ) {
<a name="l00921"></a>00921 <span class="comment">// only ask for more data on stalled sockets</span>
<a name="l00922"></a>00922 <span class="comment">// for so long</span>
<a name="l00923"></a>00923 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: 10 blank packets received"</span>);
<a name="l00924"></a>00924 }
<a name="l00925"></a>00925 }
<a name="l00926"></a>00926
<a name="l00927"></a>00927 <span class="keywordflow">if</span>( !done ) {
<a name="l00928"></a>00928 <span class="comment">// not done yet, ask for another read</span>
<a name="l00929"></a>00929 Receive(inFrag);
<a name="l00930"></a>00930 }
<a name="l00931"></a>00931 }
<a name="l00932"></a>00932 }
<a name="l00933"></a>00933
<a name="l00934"></a>00934 <span class="comment">// sends the send packet down to the device, fragmenting if</span>
<a name="l00935"></a>00935 <span class="comment">// necessary, and returns the response in receive, defragmenting</span>
<a name="l00936"></a>00936 <span class="comment">// if needed</span>
<a name="l00937"></a>00937 <span class="comment">// Blocks until response received or timed out in Usb::Device</span>
<a name="l00938"></a>00938 <span class="comment">//</span>
<a name="l00939"></a>00939 <span class="comment">// This is primarily for Desktop Database packets... Javaloader</span>
<a name="l00940"></a>00940 <span class="comment">// packets use PacketData().</span>
<a name="l00941"></a>00941 <span class="comment">//</span>
<a name="l00942"></a>00942 <span class="keywordtype">void</span> Socket::Packet(Data &send, Data &receive, <span class="keywordtype">int</span> timeout)
<a name="l00943"></a>00943 {
<a name="l00944"></a>00944 MAKE_PACKET(spack, send);
<a name="l00945"></a>00945 <span class="keywordflow">if</span>( send.GetSize() < MIN_PACKET_SIZE ||
<a name="l00946"></a>00946 (spack->command != SB_COMMAND_DB_DATA &&
<a name="l00947"></a>00947 spack->command != SB_COMMAND_DB_DONE) )
<a name="l00948"></a>00948 {
<a name="l00949"></a>00949 <span class="comment">// we don't do that around here</span>
<a name="l00950"></a>00950 eout(<span class="stringliteral">"unknown send data in Packet(): "</span> << send);
<a name="l00951"></a>00951 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Socket: unknown send data in Packet()"</span>);
<a name="l00952"></a>00952 }
<a name="l00953"></a>00953
<a name="l00954"></a>00954 <span class="comment">// assume the common case of no fragmentation,</span>
<a name="l00955"></a>00955 <span class="comment">// and use the receive buffer for input... allocate a frag buffer</span>
<a name="l00956"></a>00956 <span class="comment">// later if necessary</span>
<a name="l00957"></a>00957 Data *inputBuf = &receive;
<a name="l00958"></a>00958 receive.Zap();
<a name="l00959"></a>00959
<a name="l00960"></a>00960 <span class="keywordflow">if</span>( send.GetSize() <= MAX_PACKET_SIZE ) {
<a name="l00961"></a>00961 <span class="comment">// send non-fragmented</span>
<a name="l00962"></a>00962 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(send, *inputBuf, timeout);
<a name="l00963"></a>00963 }
<a name="l00964"></a>00964 <span class="keywordflow">else</span> {
<a name="l00965"></a>00965 <span class="comment">// send fragmented</span>
<a name="l00966"></a>00966 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset = 0;
<a name="l00967"></a>00967 Data outFrag;
<a name="l00968"></a>00968
<a name="l00969"></a>00969 <span class="comment">// You haven't to sequence packet while the whole packet isn't sent</span>
<a name="l00970"></a>00970 <span class="comment">// a) No sequence received packet</span>
<a name="l00971"></a>00971 <span class="comment">// b) 1°) Sent framgment 1/N</span>
<a name="l00972"></a>00972 <span class="comment">// 2°) Sent framgment 2/N</span>
<a name="l00973"></a>00973 <span class="comment">// ...</span>
<a name="l00974"></a>00974 <span class="comment">// N°) Before sent fragment N/N, I enable the sequence packet process.</span>
<a name="l00975"></a>00975 <span class="comment">// Sent framgment N/N</span>
<a name="l00976"></a>00976 HideSequencePacket(<span class="keyword">false</span>);
<a name="l00977"></a>00977
<a name="l00978"></a>00978 <span class="keywordflow">do</span> {
<a name="l00979"></a>00979 offset = SocketZero::MakeNextFragment(send, outFrag, offset);
<a name="l00980"></a>00980
<a name="l00981"></a>00981 <span class="comment">// Is last packet ?</span>
<a name="l00982"></a>00982 MAKE_PACKET(spack, outFrag);
<a name="l00983"></a>00983
<a name="l00984"></a>00984 <span class="keywordflow">if</span> (spack->command != SB_COMMAND_DB_FRAGMENTED)
<a name="l00985"></a>00985 HideSequencePacket(<span class="keyword">true</span>);
<a name="l00986"></a>00986
<a name="l00987"></a>00987 <a class="code" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive.">Send</a>(outFrag, *inputBuf, timeout);
<a name="l00988"></a>00988
<a name="l00989"></a>00989 <span class="comment">// only process sequence handshakes... once we</span>
<a name="l00990"></a>00990 <span class="comment">// get to the last fragment, we fall through to normal</span>
<a name="l00991"></a>00991 <span class="comment">// processing below</span>
<a name="l00992"></a>00992 <span class="keywordflow">if</span> (spack->command != SB_COMMAND_DB_FRAGMENTED) {
<a name="l00993"></a>00993 MAKE_PACKET(rpack, *inputBuf);
<a name="l00994"></a>00994
<a name="l00995"></a>00995 <span class="keywordflow">if</span>( offset && inputBuf->GetSize() > 0 ) {
<a name="l00996"></a>00996 Protocol::CheckSize(*inputBuf, SB_PACKET_HEADER_SIZE);
<a name="l00997"></a>00997
<a name="l00998"></a>00998 <span class="keywordflow">switch</span>( rpack->command )
<a name="l00999"></a>00999 {
<a name="l01000"></a>01000 <span class="keywordflow">case</span> SB_COMMAND_SEQUENCE_HANDSHAKE:
<a name="l01001"></a>01001 CheckSequence(*inputBuf);
<a name="l01002"></a>01002 <span class="keywordflow">break</span>;
<a name="l01003"></a>01003
<a name="l01004"></a>01004 <span class="keywordflow">default</span>: {
<a name="l01005"></a>01005 std::ostringstream oss;
<a name="l01006"></a>01006 oss << <span class="stringliteral">"Socket: (send) unhandled packet in Packet(): 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int)rpack->command;
<a name="l01007"></a>01007 eout(oss.str());
<a name="l01008"></a>01008 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(oss.str());
<a name="l01009"></a>01009 }
<a name="l01010"></a>01010 <span class="keywordflow">break</span>;
<a name="l01011"></a>01011 }
<a name="l01012"></a>01012 }
<a name="l01013"></a>01013 }
<a name="l01014"></a>01014
<a name="l01015"></a>01015 } <span class="keywordflow">while</span>( offset > 0 );
<a name="l01016"></a>01016
<a name="l01017"></a>01017 <span class="comment">// To be sure that it's clean...</span>
<a name="l01018"></a>01018 HideSequencePacket(<span class="keyword">true</span>);
<a name="l01019"></a>01019 }
<a name="l01020"></a>01020
<a name="l01021"></a>01021 std::auto_ptr<Data> inFrag;
<a name="l01022"></a>01022 <span class="keywordtype">bool</span> done = <span class="keyword">false</span>, frag = <span class="keyword">false</span>;
<a name="l01023"></a>01023 <span class="keywordtype">int</span> blankCount = 0;
<a name="l01024"></a>01024 <span class="keywordflow">while</span>( !done ) {
<a name="l01025"></a>01025 MAKE_PACKET(rpack, *inputBuf);
<a name="l01026"></a>01026
<a name="l01027"></a>01027 <span class="comment">// check the packet's validity</span>
<a name="l01028"></a>01028 <span class="keywordflow">if</span>( inputBuf->GetSize() > 0 ) {
<a name="l01029"></a>01029 blankCount = 0;
<a name="l01030"></a>01030
<a name="l01031"></a>01031 Protocol::CheckSize(*inputBuf, SB_PACKET_HEADER_SIZE);
<a name="l01032"></a>01032
<a name="l01033"></a>01033 <span class="keywordflow">switch</span>( rpack->command )
<a name="l01034"></a>01034 {
<a name="l01035"></a>01035 <span class="keywordflow">case</span> SB_COMMAND_SEQUENCE_HANDSHAKE:
<a name="l01036"></a>01036 CheckSequence(*inputBuf);
<a name="l01037"></a>01037 <span class="keywordflow">break</span>;
<a name="l01038"></a>01038
<a name="l01039"></a>01039 <span class="keywordflow">case</span> SB_COMMAND_DB_DATA:
<a name="l01040"></a>01040 <span class="keywordflow">if</span>( frag ) {
<a name="l01041"></a>01041 SocketZero::AppendFragment(receive, *inputBuf);
<a name="l01042"></a>01042 }
<a name="l01043"></a>01043 <span class="keywordflow">else</span> {
<a name="l01044"></a>01044 <span class="comment">// no copy needed, already in receive,</span>
<a name="l01045"></a>01045 <span class="comment">// since inputBuf starts out that way</span>
<a name="l01046"></a>01046 }
<a name="l01047"></a>01047 done = <span class="keyword">true</span>;
<a name="l01048"></a>01048 <span class="keywordflow">break</span>;
<a name="l01049"></a>01049
<a name="l01050"></a>01050 <span class="keywordflow">case</span> SB_COMMAND_DB_FRAGMENTED:
<a name="l01051"></a>01051 <span class="comment">// only copy if frag is true, since the</span>
<a name="l01052"></a>01052 <span class="comment">// first time through, receive == inputBuf</span>
<a name="l01053"></a>01053 <span class="keywordflow">if</span>( frag ) {
<a name="l01054"></a>01054 SocketZero::AppendFragment(receive, *inputBuf);
<a name="l01055"></a>01055 }
<a name="l01056"></a>01056 frag = <span class="keyword">true</span>;
<a name="l01057"></a>01057 <span class="keywordflow">break</span>;
<a name="l01058"></a>01058
<a name="l01059"></a>01059 <span class="keywordflow">case</span> SB_COMMAND_DB_DONE:
<a name="l01060"></a>01060 <span class="comment">// no copy needed, already in receive</span>
<a name="l01061"></a>01061 done = <span class="keyword">true</span>;
<a name="l01062"></a>01062 <span class="keywordflow">break</span>;
<a name="l01063"></a>01063
<a name="l01064"></a>01064 <span class="keywordflow">default</span>: {
<a name="l01065"></a>01065 std::ostringstream oss;
<a name="l01066"></a>01066 oss << <span class="stringliteral">"Socket: (read) unhandled packet in Packet(): 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int)rpack->command;
<a name="l01067"></a>01067 eout(oss.str());
<a name="l01068"></a>01068 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(oss.str());
<a name="l01069"></a>01069 }
<a name="l01070"></a>01070 <span class="keywordflow">break</span>;
<a name="l01071"></a>01071 }
<a name="l01072"></a>01072 }
<a name="l01073"></a>01073 <span class="keywordflow">else</span> {
<a name="l01074"></a>01074 blankCount++;
<a name="l01075"></a>01075 <span class="comment">//std::cerr << "Blank! " << blankCount << std::endl;</span>
<a name="l01076"></a>01076 <span class="keywordflow">if</span>( blankCount == 10 ) {
<a name="l01077"></a>01077 <span class="comment">// only ask for more data on stalled sockets</span>
<a name="l01078"></a>01078 <span class="comment">// for so long</span>
<a name="l01079"></a>01079 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Error</a>(<span class="stringliteral">"Socket: 10 blank packets received"</span>);
<a name="l01080"></a>01080 }
<a name="l01081"></a>01081 }
<a name="l01082"></a>01082
<a name="l01083"></a>01083 <span class="keywordflow">if</span>( !done ) {
<a name="l01084"></a>01084 <span class="comment">// not done yet, ask for another read, and</span>
<a name="l01085"></a>01085 <span class="comment">// create new buffer for fragmented reads</span>
<a name="l01086"></a>01086 <span class="keywordflow">if</span>( !inFrag.get() ) {
<a name="l01087"></a>01087 inFrag.reset( <span class="keyword">new</span> Data );
<a name="l01088"></a>01088 inputBuf = inFrag.get();
<a name="l01089"></a>01089 }
<a name="l01090"></a>01090 Receive(*inputBuf);
<a name="l01091"></a>01091 }
<a name="l01092"></a>01092 }
<a name="l01093"></a>01093 }
<a name="l01094"></a>01094
<a name="l01095"></a>01095 <span class="keywordtype">void</span> Socket::Packet(Barry::Packet &packet, <span class="keywordtype">int</span> timeout)
<a name="l01096"></a>01096 {
<a name="l01097"></a>01097 Packet(packet.m_send, *packet.m_receive, timeout);
<a name="l01098"></a>01098 }
<a name="l01099"></a>01099
<a name="l01100"></a>01100 <span class="keywordtype">void</span> Socket::Packet(<a class="code" href="classBarry_1_1JLPacket.html" title="Provides an API for building and analyzing raw Javaloader protocol packets.">Barry::JLPacket</a> &packet, <span class="keywordtype">int</span> timeout)
<a name="l01101"></a>01101 {
<a name="l01102"></a>01102 <span class="keywordflow">if</span>( packet.<a class="code" href="classBarry_1_1JLPacket.html#ce64e436624376a8951bbf4e963aa691">HasData</a>() ) {
<a name="l01103"></a>01103 HideSequencePacket(<span class="keyword">false</span>);
<a name="l01104"></a>01104 PacketData(packet.<a class="code" href="classBarry_1_1JLPacket.html#c53e07984e8e9f60c15c811cefcc792c">m_cmd</a>, *packet.m_receive, timeout);
<a name="l01105"></a>01105 HideSequencePacket(<span class="keyword">true</span>);
<a name="l01106"></a>01106 PacketData(packet.<a class="code" href="classBarry_1_1JLPacket.html#1c0d5773ba8f3082bc07bbc28a020174">m_data</a>, *packet.m_receive, timeout);
<a name="l01107"></a>01107 }
<a name="l01108"></a>01108 <span class="keywordflow">else</span> {
<a name="l01109"></a>01109 PacketData(packet.<a class="code" href="classBarry_1_1JLPacket.html#c53e07984e8e9f60c15c811cefcc792c">m_cmd</a>, *packet.m_receive, timeout);
<a name="l01110"></a>01110 }
<a name="l01111"></a>01111 }
<a name="l01112"></a>01112
<a name="l01113"></a>01113 <span class="keywordtype">void</span> Socket::Packet(<a class="code" href="classBarry_1_1JVMPacket.html" title="Provides an API for building and analyzing raw JavaDebug protocol packets.">Barry::JVMPacket</a> &packet, <span class="keywordtype">int</span> timeout)
<a name="l01114"></a>01114 {
<a name="l01115"></a>01115 HideSequencePacket(<span class="keyword">false</span>);
<a name="l01116"></a>01116 PacketJVM(packet.<a class="code" href="classBarry_1_1JVMPacket.html#6f3d316eb47723d876e7f90e606cb792">m_cmd</a>, *packet.m_receive, timeout);
<a name="l01117"></a>01117 HideSequencePacket(<span class="keyword">true</span>);
<a name="l01118"></a>01118 }
<a name="l01119"></a>01119
<a name="l01120"></a>01120 <span class="keywordtype">void</span> Socket::NextRecord(Data &receive)
<a name="l01121"></a>01121 {
<a name="l01122"></a>01122 Barry::Protocol::Packet packet;
<a name="l01123"></a>01123 packet.socket = htobs(GetSocket());
<a name="l01124"></a>01124 packet.size = htobs(7);
<a name="l01125"></a>01125 packet.command = SB_COMMAND_DB_DONE;
<a name="l01126"></a>01126 packet.u.db.tableCmd = 0;
<a name="l01127"></a>01127 packet.u.db.u.command.operation = 0;
<a name="l01128"></a>01128
<a name="l01129"></a>01129 Data command(&packet, 7);
<a name="l01130"></a>01130 Packet(command, receive);
<a name="l01131"></a>01131 }
<a name="l01132"></a>01132
<a name="l01133"></a>01133 <span class="keywordtype">void</span> Socket::RegisterInterest(SocketRoutingQueue::SocketDataHandlerPtr handler)
<a name="l01134"></a>01134 {
<a name="l01135"></a>01135 <span class="keywordflow">if</span>( !m_zero->m_queue )
<a name="l01136"></a>01136 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"SocketRoutingQueue required in SocketZero in order to call Socket::RegisterInterest()"</span>);
<a name="l01137"></a>01137
<a name="l01138"></a>01138 <span class="keywordflow">if</span>( m_registered )
<a name="l01139"></a>01139 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Socket already registered in Socket::RegisterInterest()!"</span>);
<a name="l01140"></a>01140
<a name="l01141"></a>01141 m_zero->m_queue->RegisterInterest(m_socket, handler);
<a name="l01142"></a>01142 m_registered = <span class="keyword">true</span>;
<a name="l01143"></a>01143 }
<a name="l01144"></a>01144
<a name="l01145"></a>01145 <span class="keywordtype">void</span> Socket::UnregisterInterest()
<a name="l01146"></a>01146 {
<a name="l01147"></a>01147 <span class="keywordflow">if</span>( m_registered ) {
<a name="l01148"></a>01148 <span class="keywordflow">if</span>( m_zero->m_queue )
<a name="l01149"></a>01149 m_zero->m_queue->UnregisterInterest(m_socket);
<a name="l01150"></a>01150 m_registered = <span class="keyword">false</span>;
<a name="l01151"></a>01151 }
<a name="l01152"></a>01152 }
<a name="l01153"></a>01153
<a name="l01154"></a>01154
<a name="l01155"></a>01155 } <span class="comment">// namespace Barry</span>
<a name="l01156"></a>01156
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:16 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>
