<!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: router.cc 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>router.cc</h1><a href="router_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 router.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Support classes for the pluggable socket routing system.</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) 2008-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">#include "<a class="code" href="router_8h.html" title="Support classes for the pluggable socket routing system.">router.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="scoped__lock_8h.html" title="Simple scope class for dealing with pthread mutex locking.">scoped_lock.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="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.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 <unistd.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="keyword">namespace </span>Barry {
<a name="l00032"></a>00032 <span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00034"></a>00034 <span class="comment"></span><span class="comment">// SocketRoutingQueue constructors</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 SocketRoutingQueue::SocketRoutingQueue(<span class="keywordtype">int</span> prealloc_buffer_count)
<a name="l00037"></a>00037 : m_dev(0)
<a name="l00038"></a>00038 , m_writeEp(0)
<a name="l00039"></a>00039 , m_readEp(0)
<a name="l00040"></a>00040 , m_interest(false)
<a name="l00041"></a>00041 , m_continue_reading(false)
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 pthread_mutex_init(&m_mutex, NULL);
<a name="l00044"></a>00044
<a name="l00045"></a>00045 pthread_mutex_init(&m_readwaitMutex, NULL);
<a name="l00046"></a>00046 pthread_cond_init(&m_readwaitCond, NULL);
<a name="l00047"></a>00047
<a name="l00048"></a>00048 AllocateBuffers(prealloc_buffer_count);
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050
<a name="l00051"></a>00051 SocketRoutingQueue::~SocketRoutingQueue()
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="comment">// thread running?</span>
<a name="l00054"></a>00054 <span class="keywordflow">if</span>( m_continue_reading ) {
<a name="l00055"></a>00055 m_continue_reading = <span class="keyword">false</span>;
<a name="l00056"></a>00056 pthread_join(m_usb_read_thread, NULL);
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00061"></a>00061 <span class="comment"></span><span class="comment">// protected members</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">//</span>
<a name="l00064"></a>00064 <span class="comment">// ReturnBuffer</span>
<a name="l00065"></a>00065 <span class="comment">//</span><span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">/// Provides a method of returning a buffer to the free queue</span>
<a name="l00067"></a>00067 <span class="comment">/// after processing. The DataHandle class calls this automatically</span>
<a name="l00068"></a>00068 <span class="comment">/// from its destructor.</span>
<a name="l00069"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#aa496dddb546fc96f337cf885dfdf219c">00069</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#aa496dddb546fc96f337cf885dfdf219c" title="Provides a method of returning a buffer to the free queue after processing.">SocketRoutingQueue::ReturnBuffer</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> *buf)
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 <span class="comment">// don't need to lock here, since m_free handles its own locking</span>
<a name="l00072"></a>00072 m_free.<a class="code" href="classBarry_1_1DataQueue.html#aea470a11cbda20dd9af1a92148ecb223" title="Pushes data into the end of the queue.">push</a>(buf);
<a name="l00073"></a>00073 }
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="comment">//</span>
<a name="l00076"></a>00076 <span class="comment">// SimpleReadThread()</span>
<a name="l00077"></a>00077 <span class="comment">//</span><span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/// Convenience thread to handle USB read activity.</span>
<a name="l00079"></a>00079 <span class="comment">///</span>
<a name="l00080"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#a43c1fc957e2da415290e86bc6e66aa25">00080</a> <span class="comment"></span><span class="keywordtype">void</span> *<a class="code" href="classBarry_1_1SocketRoutingQueue.html#a43c1fc957e2da415290e86bc6e66aa25" title="Convenience thread to handle USB read activity.">SocketRoutingQueue::SimpleReadThread</a>(<span class="keywordtype">void</span> *userptr)
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> *q = (<a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> *)userptr;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">// read from USB and write to stdout until finished</span>
<a name="l00085"></a>00085 std::string msg;
<a name="l00086"></a>00086 <span class="keywordflow">while</span>( q->m_continue_reading ) {
<a name="l00087"></a>00087 <span class="keywordflow">if</span>( !q-><a class="code" href="classBarry_1_1SocketRoutingQueue.html#aa66c053840c931e3c6f1ed2293bd3736" title="Called by the application&#39;s &quot;read thread&quot; to read the next usb packet...">DoRead</a>(msg, 1000) ) { <span class="comment">// timeout in milliseconds</span>
<a name="l00088"></a>00088 eout(<span class="stringliteral">"Error in SimpleReadThread: "</span> << msg);
<a name="l00089"></a>00089 }
<a name="l00090"></a>00090 }
<a name="l00091"></a>00091 <span class="keywordflow">return</span> 0;
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00096"></a>00096 <span class="comment"></span><span class="comment">// public API</span>
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="comment">// These functions connect the router to an external Usb::Device</span>
<a name="l00099"></a>00099 <span class="comment">// object. Normally this is handled automatically by the</span>
<a name="l00100"></a>00100 <span class="comment">// Controller class, but are public here in case they are needed.</span>
<a name="l00101"></a>00101 <span class="keywordtype">void</span> SocketRoutingQueue::SetUsbDevice(<a class="code" href="classUsb_1_1Device.html">Usb::Device</a> *dev, <span class="keywordtype">int</span> writeEp, <span class="keywordtype">int</span> readEp)
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00104"></a>00104 m_dev = dev;
<a name="l00105"></a>00105 m_writeEp = writeEp;
<a name="l00106"></a>00106 m_readEp = readEp;
<a name="l00107"></a>00107 }
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keywordtype">void</span> SocketRoutingQueue::ClearUsbDevice()
<a name="l00110"></a>00110 {
<a name="l00111"></a>00111 scoped_lock lock(m_mutex);
<a name="l00112"></a>00112 m_dev = 0;
<a name="l00113"></a>00113 lock.unlock();
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment">// wait for the DoRead cycle to finish, so the external</span>
<a name="l00116"></a>00116 <span class="comment">// Usb::Device object doesn't close before we're done with it</span>
<a name="l00117"></a>00117 scoped_lock wait(m_readwaitMutex);
<a name="l00118"></a>00118 pthread_cond_wait(&m_readwaitCond, &m_readwaitMutex);
<a name="l00119"></a>00119 }
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keywordtype">bool</span> SocketRoutingQueue::UsbDeviceReady()
<a name="l00122"></a>00122 {
<a name="l00123"></a>00123 scoped_lock lock(m_mutex);
<a name="l00124"></a>00124 <span class="keywordflow">return</span> m_dev != 0;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">//</span>
<a name="l00128"></a>00128 <span class="comment">// AllocateBuffers</span>
<a name="l00129"></a>00129 <span class="comment">//</span><span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment">/// This class starts out with no buffers, and will grow one buffer</span>
<a name="l00131"></a>00131 <span class="comment">/// at a time if needed. Call this to allocate count buffers</span>
<a name="l00132"></a>00132 <span class="comment">/// all at once and place them on the free queue. After calling</span>
<a name="l00133"></a>00133 <span class="comment">/// this function, at least count buffers will exist in the free</span>
<a name="l00134"></a>00134 <span class="comment">/// queue. If there are already count buffers, none will be added.</span>
<a name="l00135"></a>00135 <span class="comment">///</span>
<a name="l00136"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#a6b4f7e9653512bb6ad91d05894248517">00136</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#a6b4f7e9653512bb6ad91d05894248517" title="This class starts out with no buffers, and will grow one buffer at a time if needed...">SocketRoutingQueue::AllocateBuffers</a>(<span class="keywordtype">int</span> count)
<a name="l00137"></a>00137 {
<a name="l00138"></a>00138 <span class="keywordtype">int</span> todo = count - m_free.<a class="code" href="classBarry_1_1DataQueue.html#ada0c2fd55a8f221aadbf0b7165043e06" title="Returns number of items in the queue.">size</a>();
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordflow">for</span>( <span class="keywordtype">int</span> i = 0; i < todo; i++ ) {
<a name="l00141"></a>00141 <span class="comment">// m_free handles its own locking</span>
<a name="l00142"></a>00142 m_free.<a class="code" href="classBarry_1_1DataQueue.html#aea470a11cbda20dd9af1a92148ecb223" title="Pushes data into the end of the queue.">push</a>( <span class="keyword">new</span> <a class="code" href="classBarry_1_1Data.html">Data</a> );
<a name="l00143"></a>00143 }
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">//</span>
<a name="l00147"></a>00147 <span class="comment">// DefaultRead (both variations)</span>
<a name="l00148"></a>00148 <span class="comment">//</span><span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">/// Returns the data for the next unregistered socket.</span>
<a name="l00150"></a>00150 <span class="comment">/// Blocks until timeout or data is available.</span>
<a name="l00151"></a>00151 <span class="comment">/// Returns false (or null pointer) on timeout and no data.</span>
<a name="l00152"></a>00152 <span class="comment">/// With the return version of the function, there is no</span>
<a name="l00153"></a>00153 <span class="comment">/// copying performed.</span>
<a name="l00154"></a>00154 <span class="comment">///</span>
<a name="l00155"></a>00155 <span class="comment">/// This version performs a copy.</span>
<a name="l00156"></a>00156 <span class="comment">///</span>
<a name="l00157"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#adc15a0034c1dac424cf8a5dc32f12595">00157</a> <span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#adc15a0034c1dac424cf8a5dc32f12595" title="Returns the data for the next unregistered socket.">SocketRoutingQueue::DefaultRead</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout)
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a> buf = <a class="code" href="classBarry_1_1SocketRoutingQueue.html#adc15a0034c1dac424cf8a5dc32f12595" title="Returns the data for the next unregistered socket.">DefaultRead</a>(timeout);
<a name="l00160"></a>00160 <span class="keywordflow">if</span>( !buf.get() )
<a name="l00161"></a>00161 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// copy to desired buffer</span>
<a name="l00164"></a>00164 receive = *buf.get();
<a name="l00165"></a>00165 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00166"></a>00166 }
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">///</span>
<a name="l00169"></a>00169 <span class="comment">/// This version does not perform a copy.</span>
<a name="l00170"></a>00170 <span class="comment">///</span>
<a name="l00171"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#ae9fac0a9073c44567987230843712e94">00171</a> <span class="comment"></span><a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#adc15a0034c1dac424cf8a5dc32f12595" title="Returns the data for the next unregistered socket.">SocketRoutingQueue::DefaultRead</a>(<span class="keywordtype">int</span> timeout)
<a name="l00172"></a>00172 {
<a name="l00173"></a>00173 <span class="comment">// m_default handles its own locking</span>
<a name="l00174"></a>00174 <a class="code" href="classBarry_1_1Data.html">Data</a> *buf = m_default.<a class="code" href="classBarry_1_1DataQueue.html#a27d4830d37b0f7a1bee3a63b0f5a5b2b" title="Pops the next element off the front of the queue, and waits until one exists if empty...">wait_pop</a>(timeout);
<a name="l00175"></a>00175 <span class="keywordflow">return</span> <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a>(*<span class="keyword">this</span>, buf);
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="comment">//</span>
<a name="l00179"></a>00179 <span class="comment">// RegisterInterest</span>
<a name="l00180"></a>00180 <span class="comment">//</span><span class="comment"></span>
<a name="l00181"></a>00181 <span class="comment">/// Register an interest in data from a certain socket. To read</span>
<a name="l00182"></a>00182 <span class="comment">/// from that socket, use the SocketRead() function from then on.</span>
<a name="l00183"></a>00183 <span class="comment">///</span>
<a name="l00184"></a>00184 <span class="comment">/// Any non-registered socket goes in the default queue</span>
<a name="l00185"></a>00185 <span class="comment">/// and must be read by DefaultRead()</span>
<a name="l00186"></a>00186 <span class="comment">///</span>
<a name="l00187"></a>00187 <span class="comment">/// If not null, handler is called when new data is read. It will</span>
<a name="l00188"></a>00188 <span class="comment">/// be called in the same thread instance that DoRead() is called from.</span>
<a name="l00189"></a>00189 <span class="comment">/// Handler is passed the DataQueue Data pointer, and so no</span>
<a name="l00190"></a>00190 <span class="comment">/// copying is done. Once the handler returns, the data is</span>
<a name="l00191"></a>00191 <span class="comment">/// considered processed and not added to the interested queue,</span>
<a name="l00192"></a>00192 <span class="comment">/// but instead returned to m_free.</span>
<a name="l00193"></a>00193 <span class="comment">///</span>
<a name="l00194"></a>00194 <span class="comment">/// Throws std::logic_error if already registered.</span>
<a name="l00195"></a>00195 <span class="comment">///</span>
<a name="l00196"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#a5ef298211c09178f25bd043eca283ccb">00196</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#a5ef298211c09178f25bd043eca283ccb" title="Register an interest in data from a certain socket.">SocketRoutingQueue::RegisterInterest</a>(SocketId socket,
<a name="l00197"></a>00197 SocketDataHandler handler,
<a name="l00198"></a>00198 <span class="keywordtype">void</span> *context)
<a name="l00199"></a>00199 {
<a name="l00200"></a>00200 <span class="comment">// modifying our own std::map, need a lock</span>
<a name="l00201"></a>00201 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00202"></a>00202
<a name="l00203"></a>00203 SocketQueueMap::iterator qi = m_socketQueues.find(socket);
<a name="l00204"></a>00204 <span class="keywordflow">if</span>( qi != m_socketQueues.end() )
<a name="l00205"></a>00205 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"RegisterInterest requesting a previously registered socket."</span>);
<a name="l00206"></a>00206
<a name="l00207"></a>00207 m_socketQueues[socket] = QueueEntryPtr( <span class="keyword">new</span> <a class="code" href="structBarry_1_1SocketRoutingQueue_1_1QueueEntry.html">QueueEntry</a>(handler, context) );
<a name="l00208"></a>00208 m_interest = <span class="keyword">true</span>;
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210
<a name="l00211"></a>00211 <span class="comment">//</span>
<a name="l00212"></a>00212 <span class="comment">// UnregisterInterest</span>
<a name="l00213"></a>00213 <span class="comment">//</span><span class="comment"></span>
<a name="l00214"></a>00214 <span class="comment">/// Unregisters interest in data from the given socket, and discards</span>
<a name="l00215"></a>00215 <span class="comment">/// any existing data in its interest queue. Any new incoming data</span>
<a name="l00216"></a>00216 <span class="comment">/// for this socket will be placed in the default queue.</span>
<a name="l00217"></a>00217 <span class="comment">///</span>
<a name="l00218"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#aaa0f088f013150bc45ca47fabede9731">00218</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#aaa0f088f013150bc45ca47fabede9731" title="Unregisters interest in data from the given socket, and discards any existing data...">SocketRoutingQueue::UnregisterInterest</a>(SocketId socket)
<a name="l00219"></a>00219 {
<a name="l00220"></a>00220 <span class="comment">// modifying our own std::map, need a lock</span>
<a name="l00221"></a>00221 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00222"></a>00222
<a name="l00223"></a>00223 SocketQueueMap::iterator qi = m_socketQueues.find(socket);
<a name="l00224"></a>00224 <span class="keywordflow">if</span>( qi == m_socketQueues.end() )
<a name="l00225"></a>00225 <span class="keywordflow">return</span>; <span class="comment">// nothing registered, done</span>
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="comment">// salvage all our data buffers</span>
<a name="l00228"></a>00228 m_free.<a class="code" href="classBarry_1_1DataQueue.html#a12a7a82124799a6803b28efd89e1dd05" title="Pops all data from other and appends it to this.">append_from</a>( qi->second->m_queue );
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <span class="comment">// remove the QueueEntryPtr from the map</span>
<a name="l00231"></a>00231 m_socketQueues.erase( qi );
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="comment">// check the interest flag</span>
<a name="l00234"></a>00234 m_interest = m_socketQueues.size() > 0;
<a name="l00235"></a>00235 }
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="comment">//</span>
<a name="l00238"></a>00238 <span class="comment">// SocketRead</span>
<a name="l00239"></a>00239 <span class="comment">//</span><span class="comment"></span>
<a name="l00240"></a>00240 <span class="comment">/// Reads data from the interested socket cache. Can only read</span>
<a name="l00241"></a>00241 <span class="comment">/// from sockets that have been previously registered.</span>
<a name="l00242"></a>00242 <span class="comment">///</span>
<a name="l00243"></a>00243 <span class="comment">/// Blocks until timeout or data is available.</span>
<a name="l00244"></a>00244 <span class="comment">///</span>
<a name="l00245"></a>00245 <span class="comment">/// Returns false (or null pointer) on timeout and no data.</span>
<a name="l00246"></a>00246 <span class="comment">/// With the return version of the function, there is no</span>
<a name="l00247"></a>00247 <span class="comment">/// copying performed.</span>
<a name="l00248"></a>00248 <span class="comment">///</span>
<a name="l00249"></a>00249 <span class="comment">/// Throws std::logic_error if a socket was requested that was</span>
<a name="l00250"></a>00250 <span class="comment">/// not previously registered.</span>
<a name="l00251"></a>00251 <span class="comment">///</span>
<a name="l00252"></a>00252 <span class="comment">/// Copying is performed with this function.</span>
<a name="l00253"></a>00253 <span class="comment">///</span>
<a name="l00254"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#a58298b4598a0166720b745198cb99fe6">00254</a> <span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#a58298b4598a0166720b745198cb99fe6" title="Reads data from the interested socket cache.">SocketRoutingQueue::SocketRead</a>(SocketId socket, <a class="code" href="classBarry_1_1Data.html">Data</a> &receive, <span class="keywordtype">int</span> timeout)
<a name="l00255"></a>00255 {
<a name="l00256"></a>00256 <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a> buf = <a class="code" href="classBarry_1_1SocketRoutingQueue.html#a58298b4598a0166720b745198cb99fe6" title="Reads data from the interested socket cache.">SocketRead</a>(socket, timeout);
<a name="l00257"></a>00257 <span class="keywordflow">if</span>( !buf.get() )
<a name="l00258"></a>00258 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00259"></a>00259
<a name="l00260"></a>00260 <span class="comment">// copy to desired buffer</span>
<a name="l00261"></a>00261 receive = *buf.get();
<a name="l00262"></a>00262 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00263"></a>00263 }
<a name="l00264"></a>00264 <span class="comment"></span>
<a name="l00265"></a>00265 <span class="comment">///</span>
<a name="l00266"></a>00266 <span class="comment">/// Copying is not performed with this function.</span>
<a name="l00267"></a>00267 <span class="comment">///</span>
<a name="l00268"></a>00268 <span class="comment">/// Throws std::logic_error if a socket was requested that was</span>
<a name="l00269"></a>00269 <span class="comment">/// not previously registered.</span>
<a name="l00270"></a>00270 <span class="comment">///</span>
<a name="l00271"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#acbe8506c04cb6ff9942766a3ba39cbd4">00271</a> <span class="comment"></span><a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#a58298b4598a0166720b745198cb99fe6" title="Reads data from the interested socket cache.">SocketRoutingQueue::SocketRead</a>(SocketId socket, <span class="keywordtype">int</span> timeout)
<a name="l00272"></a>00272 {
<a name="l00273"></a>00273 QueueEntryPtr qep;
<a name="l00274"></a>00274 <a class="code" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory...">DataQueue</a> *dq = 0;
<a name="l00275"></a>00275
<a name="l00276"></a>00276 <span class="comment">// accessing our own std::map, need a lock</span>
<a name="l00277"></a>00277 {
<a name="l00278"></a>00278 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00279"></a>00279 SocketQueueMap::iterator qi = m_socketQueues.find(socket);
<a name="l00280"></a>00280 <span class="keywordflow">if</span>( qi == m_socketQueues.end() )
<a name="l00281"></a>00281 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"SocketRead requested data from unregistered socket."</span>);
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="comment">// got our queue, save the whole QueueEntryPtr (shared_ptr),</span>
<a name="l00284"></a>00284 <span class="comment">// and unlock, since we will be waiting on the DataQueue,</span>
<a name="l00285"></a>00285 <span class="comment">// not the socketQueues map</span>
<a name="l00286"></a>00286 <span class="comment">//</span>
<a name="l00287"></a>00287 <span class="comment">// This is safe, since even if UnregisterInterest is called,</span>
<a name="l00288"></a>00288 <span class="comment">// our pointer won't be deleted until our shared_ptr</span>
<a name="l00289"></a>00289 <span class="comment">// (QueueEntryPtr) goes out of scope.</span>
<a name="l00290"></a>00290 <span class="comment">//</span>
<a name="l00291"></a>00291 <span class="comment">// The remaining problem is that wait_pop() might wait</span>
<a name="l00292"></a>00292 <span class="comment">// forever if there is no timeout... c'est la vie.</span>
<a name="l00293"></a>00293 <span class="comment">// Should'a used a timeout. :-)</span>
<a name="l00294"></a>00294 qep = qi->second;
<a name="l00295"></a>00295 dq = &qep->m_queue;
<a name="l00296"></a>00296 }
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="comment">// get data from DataQueue</span>
<a name="l00299"></a>00299 <a class="code" href="classBarry_1_1Data.html">Data</a> *buf = dq-><a class="code" href="classBarry_1_1DataQueue.html#a27d4830d37b0f7a1bee3a63b0f5a5b2b" title="Pops the next element off the front of the queue, and waits until one exists if empty...">wait_pop</a>(timeout);
<a name="l00300"></a>00300
<a name="l00301"></a>00301 <span class="comment">// specifically delete our copy of shared pointer, in a locked</span>
<a name="l00302"></a>00302 <span class="comment">// environment</span>
<a name="l00303"></a>00303 {
<a name="l00304"></a>00304 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00305"></a>00305 qep.reset();
<a name="l00306"></a>00306 }
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="keywordflow">return</span> <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a>(*<span class="keyword">this</span>, buf);
<a name="l00309"></a>00309 }
<a name="l00310"></a>00310
<a name="l00311"></a>00311 <span class="comment">// Returns true if data is available for that socket.</span>
<a name="l00312"></a>00312 <span class="keywordtype">bool</span> SocketRoutingQueue::IsAvailable(SocketId socket)<span class="keyword"> const</span>
<a name="l00313"></a>00313 <span class="keyword"></span>{
<a name="l00314"></a>00314 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00315"></a>00315 SocketQueueMap::const_iterator qi = m_socketQueues.find(socket);
<a name="l00316"></a>00316 <span class="keywordflow">if</span>( qi == m_socketQueues.end() )
<a name="l00317"></a>00317 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00318"></a>00318 <span class="keywordflow">return</span> qi->second->m_queue.size() > 0;
<a name="l00319"></a>00319 }
<a name="l00320"></a>00320
<a name="l00321"></a>00321 <span class="comment">//</span>
<a name="l00322"></a>00322 <span class="comment">// DoRead</span>
<a name="l00323"></a>00323 <span class="comment">//</span><span class="comment"></span>
<a name="l00324"></a>00324 <span class="comment">/// Called by the application's "read thread" to read the next usb</span>
<a name="l00325"></a>00325 <span class="comment">/// packet and route it to the correct queue. Returns after every</span>
<a name="l00326"></a>00326 <span class="comment">/// read, even if a handler is associated with a queue.</span>
<a name="l00327"></a>00327 <span class="comment">/// Note: this function is safe to call before SetUsbDevice() is</span>
<a name="l00328"></a>00328 <span class="comment">/// called... it just doesn't do anything if there is no usb</span>
<a name="l00329"></a>00329 <span class="comment">/// device to work with.</span>
<a name="l00330"></a>00330 <span class="comment">///</span>
<a name="l00331"></a>00331 <span class="comment">/// Timeout is in milliseconds.</span>
<a name="l00332"></a>00332 <span class="comment">///</span>
<a name="l00333"></a>00333 <span class="comment">/// Returns false in the case of USB errors and puts the error message</span>
<a name="l00334"></a>00334 <span class="comment">/// in msg.</span>
<a name="l00335"></a>00335 <span class="comment">///</span>
<a name="l00336"></a><a class="code" href="classBarry_1_1SocketRoutingQueue.html#aa66c053840c931e3c6f1ed2293bd3736">00336</a> <span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1SocketRoutingQueue.html#aa66c053840c931e3c6f1ed2293bd3736" title="Called by the application&#39;s &quot;read thread&quot; to read the next usb packet...">SocketRoutingQueue::DoRead</a>(std::string &msg, <span class="keywordtype">int</span> timeout)
<a name="l00337"></a>00337 {
<a name="l00338"></a>00338 <span class="keyword">class </span>ReadWaitSignal
<a name="l00339"></a>00339 {
<a name="l00340"></a>00340 pthread_mutex_t &m_Mutex;
<a name="l00341"></a>00341 pthread_cond_t &m_Cond;
<a name="l00342"></a>00342 <span class="keyword">public</span>:
<a name="l00343"></a>00343 ReadWaitSignal(pthread_mutex_t &mut, pthread_cond_t &cond)
<a name="l00344"></a>00344 : m_Mutex(mut), m_Cond(cond)
<a name="l00345"></a>00345 {}
<a name="l00346"></a>00346 ~ReadWaitSignal()
<a name="l00347"></a>00347 {
<a name="l00348"></a>00348 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> wait(m_Mutex);
<a name="l00349"></a>00349 pthread_cond_signal(&m_Cond);
<a name="l00350"></a>00350 }
<a name="l00351"></a>00351 } readwait(m_readwaitMutex, m_readwaitCond);
<a name="l00352"></a>00352
<a name="l00353"></a>00353 <a class="code" href="classUsb_1_1Device.html">Usb::Device</a> * <span class="keyword">volatile</span> dev = 0;
<a name="l00354"></a>00354 <span class="keywordtype">int</span> readEp;
<a name="l00355"></a>00355 <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a> buf(*<span class="keyword">this</span>, 0);
<a name="l00356"></a>00356
<a name="l00357"></a>00357 <span class="comment">// if we are not connected to a USB device yet, just wait</span>
<a name="l00358"></a>00358 {
<a name="l00359"></a>00359 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00360"></a>00360
<a name="l00361"></a>00361 <span class="keywordflow">if</span>( !m_dev ) {
<a name="l00362"></a>00362 lock.unlock(); <span class="comment">// unlock early, since we're sleeping</span>
<a name="l00363"></a>00363 <span class="comment">// sleep only a short time, since things could be</span>
<a name="l00364"></a>00364 <span class="comment">// in the process of setup or teardown</span>
<a name="l00365"></a>00365 usleep(125000);
<a name="l00366"></a>00366 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00367"></a>00367 }
<a name="l00368"></a>00368
<a name="l00369"></a>00369 dev = m_dev;
<a name="l00370"></a>00370 readEp = m_readEp;
<a name="l00371"></a>00371
<a name="l00372"></a>00372 <span class="comment">// fetch a free buffer</span>
<a name="l00373"></a>00373 <a class="code" href="classBarry_1_1Data.html">Data</a> *raw = m_free.<a class="code" href="classBarry_1_1DataQueue.html#ad1f454f70a9b6ec667e0e22a7ddd6eca" title="Pops the next element off the front of the queue.">pop</a>();
<a name="l00374"></a>00374 <span class="keywordflow">if</span>( !raw )
<a name="l00375"></a>00375 buf = <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a>(*<span class="keyword">this</span>, <span class="keyword">new</span> <a class="code" href="classBarry_1_1Data.html">Data</a>);
<a name="l00376"></a>00376 <span class="keywordflow">else</span>
<a name="l00377"></a>00377 buf = <a class="code" href="classBarry_1_1DataHandle.html" title="std::auto_ptr like class that handles pointers to Data, but instead of freeing them...">DataHandle</a>(*<span class="keyword">this</span>, raw);
<a name="l00378"></a>00378 }
<a name="l00379"></a>00379
<a name="l00380"></a>00380 <span class="comment">// take a chance and do the read unlocked, as this has the potential</span>
<a name="l00381"></a>00381 <span class="comment">// for blocking for a while</span>
<a name="l00382"></a>00382 <span class="keywordflow">try</span> {
<a name="l00383"></a>00383
<a name="l00384"></a>00384 <a class="code" href="classBarry_1_1Data.html">Data</a> &data = *buf.get();
<a name="l00385"></a>00385
<a name="l00386"></a>00386 <span class="keywordflow">if</span>( !dev->BulkRead(readEp, data, timeout) )
<a name="l00387"></a>00387 <span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// no data, done!</span>
<a name="l00388"></a>00388
<a name="l00389"></a>00389 MAKE_PACKET(pack, data);
<a name="l00390"></a>00390
<a name="l00391"></a>00391 <span class="comment">// make sure the size is right</span>
<a name="l00392"></a>00392 <span class="keywordflow">if</span>( data.GetSize() < <span class="keyword">sizeof</span>(pack->socket) )
<a name="l00393"></a>00393 <span class="keywordflow">return</span> <span class="keyword">true</span>; <span class="comment">// bad size, just skip</span>
<a name="l00394"></a>00394
<a name="l00395"></a>00395 <span class="comment">// extract the socket from the packet</span>
<a name="l00396"></a>00396 uint16_t socket = btohs(pack->socket);
<a name="l00397"></a>00397
<a name="l00398"></a>00398 <span class="comment">// we have data, now lock up again to place it</span>
<a name="l00399"></a>00399 <span class="comment">// in the right queue</span>
<a name="l00400"></a>00400 <a class="code" href="classBarry_1_1scoped__lock.html">scoped_lock</a> lock(m_mutex);
<a name="l00401"></a>00401
<a name="l00402"></a>00402 <span class="comment">// search for registration of socket</span>
<a name="l00403"></a>00403 <span class="keywordflow">if</span>( m_interest ) {
<a name="l00404"></a>00404 SocketQueueMap::iterator qi = m_socketQueues.find(socket);
<a name="l00405"></a>00405 <span class="keywordflow">if</span>( qi != m_socketQueues.end() ) {
<a name="l00406"></a>00406 SocketDataHandler sdh = qi->second->m_handler;
<a name="l00407"></a>00407 <span class="keywordtype">void</span> *ctx = qi->second->m_context;
<a name="l00408"></a>00408
<a name="l00409"></a>00409 <span class="comment">// is there a handler?</span>
<a name="l00410"></a>00410 <span class="keywordflow">if</span>( sdh ) {
<a name="l00411"></a>00411 <span class="comment">// unlock & let the handler process it</span>
<a name="l00412"></a>00412 lock.unlock();
<a name="l00413"></a>00413 (*sdh)(ctx, buf.get());
<a name="l00414"></a>00414 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00415"></a>00415 }
<a name="l00416"></a>00416 <span class="keywordflow">else</span> {
<a name="l00417"></a>00417 qi->second->m_queue.push(buf.release());
<a name="l00418"></a>00418 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00419"></a>00419 }
<a name="l00420"></a>00420 }
<a name="l00421"></a>00421
<a name="l00422"></a>00422 <span class="comment">// fall through</span>
<a name="l00423"></a>00423 }
<a name="l00424"></a>00424
<a name="l00425"></a>00425 <span class="comment">// safe to unlock now, we are done with the map</span>
<a name="l00426"></a>00426 lock.unlock();
<a name="l00427"></a>00427
<a name="l00428"></a>00428 <span class="comment">// if we get here, send to default queue</span>
<a name="l00429"></a>00429 m_default.<a class="code" href="classBarry_1_1DataQueue.html#aea470a11cbda20dd9af1a92148ecb223" title="Pushes data into the end of the queue.">push</a>(buf.release());
<a name="l00430"></a>00430 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00431"></a>00431
<a name="l00432"></a>00432 }
<a name="l00433"></a>00433 <span class="keywordflow">catch</span>( <a class="code" href="classUsb_1_1Timeout.html">Usb::Timeout</a> & ) {
<a name="l00434"></a>00434 <span class="comment">// this is expected... just ignore</span>
<a name="l00435"></a>00435 }
<a name="l00436"></a>00436 <span class="keywordflow">catch</span>( <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a> &ue ) {
<a name="l00437"></a>00437 <span class="comment">// this is unexpected, but we're in a thread here...</span>
<a name="l00438"></a>00438 <span class="comment">// return false and the caller decide how to handle it</span>
<a name="l00439"></a>00439 msg = ue.what();
<a name="l00440"></a>00440 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00441"></a>00441 }
<a name="l00442"></a>00442
<a name="l00443"></a>00443 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00444"></a>00444 }
<a name="l00445"></a>00445
<a name="l00446"></a>00446 <span class="keywordtype">void</span> SocketRoutingQueue::SpinoffSimpleReadThread()
<a name="l00447"></a>00447 {
<a name="l00448"></a>00448 <span class="comment">// signal that it's ok to run inside the thread</span>
<a name="l00449"></a>00449 <span class="keywordflow">if</span>( m_continue_reading )
<a name="l00450"></a>00450 <span class="keywordflow">return</span>; <span class="comment">// already running</span>
<a name="l00451"></a>00451 m_continue_reading = <span class="keyword">true</span>;
<a name="l00452"></a>00452
<a name="l00453"></a>00453 <span class="comment">// Start USB read thread, to handle all routing</span>
<a name="l00454"></a>00454 <span class="keywordtype">int</span> ret = pthread_create(&m_usb_read_thread, NULL, &<a class="code" href="classBarry_1_1SocketRoutingQueue.html#a43c1fc957e2da415290e86bc6e66aa25" title="Convenience thread to handle USB read activity.">SimpleReadThread</a>, <span class="keyword">this</span>);
<a name="l00455"></a>00455 <span class="keywordflow">if</span>( ret ) {
<a name="l00456"></a>00456 m_continue_reading = <span class="keyword">false</span>;
<a name="l00457"></a>00457 <span class="keywordflow">throw</span> <a class="code" href="classBarry_1_1ErrnoError.html" title="System error that provides an errno error code.">Barry::ErrnoError</a>(<span class="stringliteral">"SocketRoutingQueue: Error creating USB read thread."</span>, ret);
<a name="l00458"></a>00458 }
<a name="l00459"></a>00459 }
<a name="l00460"></a>00460
<a name="l00461"></a>00461 } <span class="comment">// namespace Barry</span>
<a name="l00462"></a>00462
</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>
