<!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: socket.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>socket.h</h1><a href="socket_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 socket.h</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-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_SOCKET_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_SOCKET_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdint.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <queue></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <memory></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="router_8h.html" title="Support classes for the pluggable socket routing system.">router.h</a>"</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="comment">// forward declarations</span>
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Usb { <span class="keyword">class </span>Device; }
<a name="l00033"></a>00033 <span class="keyword">namespace </span>Barry {
<a name="l00034"></a>00034 <span class="keyword">class </span>Data;
<a name="l00035"></a>00035 <span class="keyword">class </span>Packet;
<a name="l00036"></a>00036 <span class="keyword">class </span>JLPacket;
<a name="l00037"></a>00037 <span class="keyword">class </span>JVMPacket;
<a name="l00038"></a>00038 <span class="keyword">class </span>SocketRoutingQueue;
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">namespace </span>Barry {
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">class </span>Socket;
<a name="l00044"></a>00044 <span class="keyword">typedef</span> std::auto_ptr<Socket> SocketHandle;
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classBarry_1_1SocketZero.html">00046</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1SocketZero.html">SocketZero</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_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <a class="code" href="classUsb_1_1Device.html">Usb::Device</a> *m_dev;
<a name="l00051"></a>00051 <a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> *m_queue;
<a name="l00052"></a>00052 <span class="keywordtype">int</span> m_writeEp, m_readEp;
<a name="l00053"></a>00053 uint8_t m_zeroSocketSequence;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 uint32_t m_sequenceId;
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">// half open socket stata, for passwords</span>
<a name="l00058"></a>00058 <span class="keywordtype">bool</span> m_halfOpen;
<a name="l00059"></a>00059 uint32_t m_challengeSeed;
<a name="l00060"></a>00060 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_remainingTries;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> m_hideSequencePacket;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keywordtype">bool</span> m_resetOnClose;
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">private</span>:
<a name="l00067"></a>00067 <span class="keyword">static</span> <span class="keywordtype">void</span> AppendFragment(<a class="code" href="classBarry_1_1Data.html">Data</a> &whole, <span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &fragment);
<a name="l00068"></a>00068 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> MakeNextFragment(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &whole, <a class="code" href="classBarry_1_1Data.html">Data</a> &fragment,
<a name="l00069"></a>00069 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset = 0);
<a name="l00070"></a>00070 <span class="keywordtype">void</span> CheckSequence(uint16_t socket, <span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &seq);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordtype">void</span> SendOpen(uint16_t socket, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<a name="l00073"></a>00073 <span class="keywordtype">void</span> SendPasswordHash(uint16_t socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *password, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">// Raw send and receive functions, used for all low level</span>
<a name="l00076"></a>00076 <span class="comment">// communication to the USB level.</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> RawSend(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <span class="keywordtype">int</span> timeout = -1);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> RawReceive(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">protected</span>:
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> SequencePacket(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &data);
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> IsSequencePacketHidden() { <span class="keywordflow">return</span> m_hideSequencePacket; }
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">public</span>:
<a name="l00085"></a>00085 <span class="keywordtype">void</span> SetResetOnClose(<span class="keywordtype">bool</span> flag) { m_resetOnClose = flag; }
<a name="l00086"></a>00086 <span class="keywordtype">void</span> HideSequencePacket(<span class="keywordtype">bool</span> flag) { m_hideSequencePacket = flag; }
<a name="l00087"></a>00087 <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a>(<a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> &queue, <span class="keywordtype">int</span> writeEndpoint,
<a name="l00088"></a>00088 uint8_t zeroSocketSequenceStart = 0);
<a name="l00089"></a>00089 <a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a>(<a class="code" href="classUsb_1_1Device.html">Usb::Device</a> &dev, <span class="keywordtype">int</span> writeEndpoint, <span class="keywordtype">int</span> readEndpoint,
<a name="l00090"></a>00090 uint8_t zeroSocketSequenceStart = 0);
<a name="l00091"></a>00091 ~<a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a>();
<a name="l00092"></a>00092
<a name="l00093"></a>00093 uint8_t GetZeroSocketSequence()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_zeroSocketSequence; }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordtype">void</span> SetRoutingQueue(<a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> &queue);
<a name="l00096"></a>00096 <span class="keywordtype">void</span> UnlinkRoutingQueue();
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">// Send functions for socket 0 only.</span>
<a name="l00099"></a>00099 <span class="comment">// These functions will overwrite:</span>
<a name="l00100"></a>00100 <span class="comment">// - the zeroSocketSequence byte *inside* the packet</span>
<a name="l00101"></a>00101 <span class="comment">// - the socket number to 0</span>
<a name="l00102"></a>00102 <span class="comment">//</span>
<a name="l00103"></a>00103 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <span class="keywordtype">int</span> timeout = -1); <span class="comment">// send only</span>
<a name="l00104"></a>00104 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1); <span class="comment">// send+recv</span>
<a name="l00105"></a>00105 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Packet.html">Barry::Packet</a> &packet, <span class="keywordtype">int</span> timeout = -1);
<a name="l00106"></a>00106 <span class="keywordtype">void</span> Receive(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">// Opens a new socket and returns a Socket object to manage it</span>
<a name="l00109"></a>00109 SocketHandle Open(uint16_t socket, <span class="keyword">const</span> <span class="keywordtype">char</span> *password = 0);
<a name="l00110"></a>00110 <span class="keywordtype">void</span> Close(<a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a> &socket);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// Lower level USB operations</span>
<a name="l00113"></a>00113 <span class="keywordtype">void</span> ClearHalt();
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">//</span>
<a name="l00118"></a>00118 <span class="comment">// Socket class</span>
<a name="l00119"></a>00119 <span class="comment">//</span><span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment">/// Encapsulates a "logical socket" in the Blackberry USB protocol.</span>
<a name="l00121"></a>00121 <span class="comment">/// By default, provides raw send/receive access, as well as packet</span>
<a name="l00122"></a>00122 <span class="comment">/// writing on socket 0, which is always open.</span>
<a name="l00123"></a>00123 <span class="comment">///</span>
<a name="l00124"></a>00124 <span class="comment">/// There are Open and Close members to open data sockets which are used</span>
<a name="l00125"></a>00125 <span class="comment">/// to transfer data to and from the device.</span>
<a name="l00126"></a>00126 <span class="comment">///</span>
<a name="l00127"></a>00127 <span class="comment">/// The destructor will close any non-0 open sockets automatically.</span>
<a name="l00128"></a>00128 <span class="comment">///</span>
<a name="l00129"></a>00129 <span class="comment">/// Requires an active Usb::Device object to work on.</span>
<a name="l00130"></a>00130 <span class="comment">///</span>
<a name="l00131"></a><a class="code" href="classBarry_1_1Socket.html">00131</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>
<a name="l00132"></a>00132 {
<a name="l00133"></a>00133 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a>;
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a> *m_zero;
<a name="l00136"></a>00136 uint16_t m_socket;
<a name="l00137"></a>00137 uint8_t m_closeFlag;
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">bool</span> m_registered;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keyword">protected</span>:
<a name="l00142"></a>00142 <span class="keywordtype">void</span> CheckSequence(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &seq);
<a name="l00143"></a>00143 <span class="keywordtype">void</span> ForceClosed();
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>(<a class="code" href="classBarry_1_1SocketZero.html">SocketZero</a> &zero, uint16_t socket, uint8_t closeFlag);
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keyword">public</span>:
<a name="l00148"></a>00148 ~<a class="code" href="classBarry_1_1Socket.html" title="Encapsulates a &quot;logical socket&quot; in the Blackberry USB protocol.">Socket</a>();
<a name="l00149"></a>00149
<a name="l00150"></a>00150 uint16_t GetSocket()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_socket; }
<a name="l00151"></a>00151 uint8_t GetCloseFlag()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_closeFlag; }
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordtype">void</span> Close();
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">// Send and Receive are available before Open...</span>
<a name="l00156"></a>00156 <span class="comment">// an unopened socket defaults to socket 0, which you need</span>
<a name="l00157"></a>00157 <span class="comment">// in order to set the blackberry mode</span>
<a name="l00158"></a>00158 <span class="comment">// The send function will overwrite the zeroSocketSequence byte</span>
<a name="l00159"></a>00159 <span class="comment">// *inside* the packet, if the current m_socket is 0.</span>
<a name="l00160"></a>00160 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <span class="keywordtype">int</span> timeout = -1); <span class="comment">// send only</span>
<a name="l00161"></a>00161 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1); <span class="comment">// send+recv</span>
<a name="l00162"></a>00162 <span class="keywordtype">void</span> Send(<a class="code" href="classBarry_1_1Packet.html">Barry::Packet</a> &packet, <span class="keywordtype">int</span> timeout = -1);
<a name="l00163"></a>00163 <span class="keywordtype">void</span> Receive(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00164"></a>00164 <span class="keywordtype">void</span> ReceiveData(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">// Lower level USB operations</span>
<a name="l00167"></a>00167 <span class="keywordtype">void</span> ClearHalt();
<a name="l00168"></a>00168
<a name="l00169"></a>00169 <span class="comment">// sends the send packet down to the device, fragmenting if</span>
<a name="l00170"></a>00170 <span class="comment">// necessary, and returns the response in receive, defragmenting</span>
<a name="l00171"></a>00171 <span class="comment">// if needed</span>
<a name="l00172"></a>00172 <span class="comment">// Blocks until response received or timed out in Usb::Device</span>
<a name="l00173"></a>00173 <span class="keywordtype">void</span> <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, <span class="keywordtype">int</span> timeout = -1);
<a name="l00174"></a>00174 <span class="keywordtype">void</span> Packet(<a class="code" href="classBarry_1_1Packet.html">Barry::Packet</a> &packet, <span class="keywordtype">int</span> timeout = -1);
<a name="l00175"></a>00175 <span class="keywordtype">void</span> 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 = -1);
<a name="l00176"></a>00176 <span class="keywordtype">void</span> 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 = -1);
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="comment">// Use this function to send packet to JVM instead of Packet function</span>
<a name="l00179"></a>00179 <span class="keywordtype">void</span> InitSequence(<span class="keywordtype">int</span> timeout = -1);
<a name="l00180"></a>00180 <span class="keywordtype">void</span> PacketJVM(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">// Use this function to send data packet instead of Packet function</span>
<a name="l00183"></a>00183 <span class="comment">// Indeed, Packet function is used to send command (and not data)</span>
<a name="l00184"></a>00184 <span class="keywordtype">void</span> PacketData(<a class="code" href="classBarry_1_1Data.html">Data</a> &send, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout = -1);
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="comment">// some handy wrappers for the Packet() interface</span>
<a name="l00187"></a>00187 <span class="keywordtype">void</span> NextRecord(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive);
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">// Register a callback for incoming data from the device.</span>
<a name="l00190"></a>00190 <span class="comment">// This function assumes that this socket is based on a socketZero</span>
<a name="l00191"></a>00191 <span class="comment">// that has a SocketRoutingQueue, otherwise throws logic_error.</span>
<a name="l00192"></a>00192 <span class="keywordtype">void</span> RegisterInterest(SocketRoutingQueue::SocketDataHandler handler, <span class="keywordtype">void</span> *context);
<a name="l00193"></a>00193 <span class="keywordtype">void</span> UnregisterInterest();
<a name="l00194"></a>00194
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="comment">// This function is quickly written</span>
<a name="l00197"></a>00197 <span class="comment">// It's very durty :( (but it's usefull to test...)</span>
<a name="l00198"></a>00198 <span class="keywordtype">void</span> HideSequencePacket(<span class="keywordtype">bool</span> flag) { m_zero->HideSequencePacket(flag); }
<a name="l00199"></a>00199 };
<a name="l00200"></a>00200
<a name="l00201"></a>00201
<a name="l00202"></a>00202 } <span class="comment">// namespace Barry</span>
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="preprocessor">#endif</span>
<a name="l00205"></a>00205 <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>
