<!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: router.h 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>router.h</h1><a href="router_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 router.h</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) 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">#ifndef __BARRY_ROUTER_H__</span> <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_ROUTER_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 <map></span> <a name="l00028"></a>00028 <span class="preprocessor">#include <tr1/memory></span> <a name="l00029"></a>00029 <span class="preprocessor">#include <stdexcept></span> <a name="l00030"></a>00030 <span class="preprocessor">#include <pthread.h></span> <a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="dataqueue_8h.html" title="FIFO queue of Data objects.">dataqueue.h</a>"</span> <a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span> <a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span> <a name="l00034"></a>00034 <a name="l00035"></a>00035 <span class="keyword">namespace </span>Barry { <a name="l00036"></a>00036 <a name="l00037"></a>00037 <span class="keyword">class </span>DataHandle; <a name="l00038"></a>00038 <a name="l00039"></a>00039 <span class="keyword">class </span>BXEXPORT SocketRoutingQueue <a name="l00040"></a>00040 { <a name="l00041"></a>00041 <span class="keyword">friend</span> <span class="keyword">class </span>DataHandle; <a name="l00042"></a>00042 <a name="l00043"></a>00043 <span class="keyword">public</span>: <a name="l00044"></a>00044 <span class="comment">// Interface class for socket data callbacks</span> <a name="l00045"></a>00045 <span class="comment">// See RegisterInterest() for more information.</span> <a name="l00046"></a>00046 <span class="keyword">class </span>BXEXPORT SocketDataHandler <a name="l00047"></a>00047 { <a name="l00048"></a>00048 <span class="keyword">public</span>: <a name="l00049"></a>00049 <span class="comment">// Called when data is received on the socket</span> <a name="l00050"></a>00050 <span class="comment">// for which interest has been registered.</span> <a name="l00051"></a>00051 <span class="comment">//</span> <a name="l00052"></a>00052 <span class="comment">// The lifetime of the data parameter is only valid</span> <a name="l00053"></a>00053 <span class="comment">// for the duration of this method call.</span> <a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DataReceived(Data& data) = 0; <a name="l00055"></a>00055 <a name="l00056"></a>00056 <span class="comment">// Called when an error has occured on the socket</span> <a name="l00057"></a>00057 <span class="comment">// for which interest has been registered.</span> <a name="l00058"></a>00058 <span class="comment">//</span> <a name="l00059"></a>00059 <span class="comment">// The lifetime of the error parameter is only valid</span> <a name="l00060"></a>00060 <span class="comment">// for the lifetime of this method call.</span> <a name="l00061"></a>00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Error(<a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Barry::Error</a> &error); <a name="l00062"></a>00062 <a name="l00063"></a>00063 <span class="keyword">virtual</span> ~SocketDataHandler(); <a name="l00064"></a>00064 }; <a name="l00065"></a>00065 <a name="l00066"></a>00066 <span class="keyword">typedef</span> std::tr1::shared_ptr<SocketDataHandler> SocketDataHandlerPtr; <a name="l00067"></a>00067 <a name="l00068"></a>00068 <span class="comment">// Simple wrapper template class for SocketDataHandler which provides a basic data recieved callback</span> <a name="l00069"></a>00069 <span class="keyword">template</span><<span class="keyword">typename</span> T> <span class="keyword">class </span>SimpleSocketDataHandler : <span class="keyword">public</span> SocketDataHandler <a name="l00070"></a>00070 { <a name="l00071"></a>00071 void (*m_callback)(T&, Data*); <a name="l00072"></a>00072 T& m_context; <a name="l00073"></a>00073 <span class="keyword">public</span>: <a name="l00074"></a>00074 SimpleSocketDataHandler<T>(T& context, void (*callback)(T& context, Data* data)) <a name="l00075"></a>00075 : m_callback(callback) <a name="l00076"></a>00076 , m_context(context) <a name="l00077"></a>00077 {} <a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DataReceived(Data& data) <a name="l00079"></a>00079 { <a name="l00080"></a>00080 m_callback(m_context, &data); <a name="l00081"></a>00081 } <a name="l00082"></a>00082 }; <a name="l00083"></a>00083 <a name="l00084"></a>00084 <span class="keyword">struct </span>QueueEntry <a name="l00085"></a>00085 { <a name="l00086"></a>00086 SocketDataHandlerPtr m_handler; <a name="l00087"></a>00087 DataQueue m_queue; <a name="l00088"></a>00088 <a name="l00089"></a>00089 QueueEntry(SocketDataHandlerPtr h) <a name="l00090"></a>00090 : m_handler(h) <a name="l00091"></a>00091 {} <a name="l00092"></a>00092 }; <a name="l00093"></a>00093 <span class="keyword">typedef</span> std::tr1::shared_ptr<QueueEntry> QueueEntryPtr; <a name="l00094"></a>00094 <span class="keyword">typedef</span> uint16_t SocketId; <a name="l00095"></a>00095 <span class="keyword">typedef</span> std::map<SocketId, QueueEntryPtr> SocketQueueMap; <a name="l00096"></a>00096 <a name="l00097"></a>00097 <span class="keyword">private</span>: <a name="l00098"></a>00098 Usb::Device * <span class="keyword">volatile</span> m_dev; <a name="l00099"></a>00099 <span class="keyword">volatile</span> <span class="keywordtype">int</span> m_writeEp, m_readEp; <a name="l00100"></a>00100 <a name="l00101"></a>00101 <span class="keyword">volatile</span> <span class="keywordtype">bool</span> m_interest; <span class="comment">// true if at least one socket has an interest.</span> <a name="l00102"></a>00102 <span class="comment">// used to optimize the reading</span> <a name="l00103"></a>00103 <a name="l00104"></a>00104 <span class="keyword">mutable</span> pthread_mutex_t m_mutex;<span class="comment">// controls access to local data, but not</span> <a name="l00105"></a>00105 <span class="comment">// DataQueues, as they have their own</span> <a name="l00106"></a>00106 <span class="comment">// locking per queue</span> <a name="l00107"></a>00107 <a name="l00108"></a>00108 pthread_mutex_t m_readwaitMutex; <a name="l00109"></a>00109 pthread_cond_t m_readwaitCond; <a name="l00110"></a>00110 <span class="keywordtype">bool</span> m_seen_usb_error; <a name="l00111"></a>00111 SocketDataHandlerPtr m_usb_error_dev_callback; <a name="l00112"></a>00112 <a name="l00113"></a>00113 DataQueue m_free; <a name="l00114"></a>00114 DataQueue m_default; <a name="l00115"></a>00115 SocketQueueMap m_socketQueues; <a name="l00116"></a>00116 <a name="l00117"></a>00117 <span class="keywordtype">int</span> m_timeout; <a name="l00118"></a>00118 <a name="l00119"></a>00119 <span class="comment">// thread state</span> <a name="l00120"></a>00120 pthread_t m_usb_read_thread; <a name="l00121"></a>00121 <span class="keyword">volatile</span> <span class="keywordtype">bool</span> m_continue_reading;<span class="comment">// set to true when the thread is created,</span> <a name="l00122"></a>00122 <span class="comment">// then set to false in the destructor</span> <a name="l00123"></a>00123 <span class="comment">// to signal the end of the thread</span> <a name="l00124"></a>00124 <span class="comment">// and handle the join</span> <a name="l00125"></a>00125 <a name="l00126"></a>00126 <span class="keyword">protected</span>: <a name="l00127"></a>00127 <span class="comment">// Provides a method of returning a buffer to the free queue</span> <a name="l00128"></a>00128 <span class="comment">// after processing. The DataHandle class calls this automatically</span> <a name="l00129"></a>00129 <span class="comment">// from its destructor.</span> <a name="l00130"></a>00130 <span class="keywordtype">void</span> ReturnBuffer(Data *buf); <a name="l00131"></a>00131 <a name="l00132"></a>00132 <span class="comment">// Thread function for the simple read behaviour... thread is</span> <a name="l00133"></a>00133 <span class="comment">// created in the SpinoffSimpleReadThread() member below.</span> <a name="l00134"></a>00134 <span class="keyword">static</span> <span class="keywordtype">void</span> *SimpleReadThread(<span class="keywordtype">void</span> *userptr); <a name="l00135"></a>00135 <a name="l00136"></a>00136 <span class="keyword">public</span>: <a name="l00137"></a>00137 SocketRoutingQueue(<span class="keywordtype">int</span> prealloc_buffer_count = 4, <a name="l00138"></a>00138 <span class="keywordtype">int</span> default_read_timeout = USBWRAP_DEFAULT_TIMEOUT); <a name="l00139"></a>00139 ~SocketRoutingQueue(); <a name="l00140"></a>00140 <a name="l00141"></a>00141 <span class="comment">//</span> <a name="l00142"></a>00142 <span class="comment">// data access</span> <a name="l00143"></a>00143 <span class="comment">//</span> <a name="l00144"></a>00144 <span class="keywordtype">int</span> GetWriteEp()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_writeEp; } <a name="l00145"></a>00145 <span class="keywordtype">int</span> GetReadEp()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_readEp; } <a name="l00146"></a>00146 <a name="l00147"></a>00147 <a name="l00148"></a>00148 <span class="comment">// These functions connect the router to an external Usb::Device</span> <a name="l00149"></a>00149 <span class="comment">// object. Normally this is handled automatically by the</span> <a name="l00150"></a>00150 <span class="comment">// Controller class, but are public here in case they are needed.</span> <a name="l00151"></a>00151 <span class="comment">//</span> <a name="l00152"></a>00152 <span class="comment">// If DoRead encounters an error, it sets a flag and stops</span> <a name="l00153"></a>00153 <span class="comment">// reading. To recover, you should handle the Error() call in</span> <a name="l00154"></a>00154 <span class="comment">// the callback, fix the USB device, and then call</span> <a name="l00155"></a>00155 <span class="comment">// ClearUsbError() to clear the flag.</span> <a name="l00156"></a>00156 <span class="comment">//</span> <a name="l00157"></a>00157 <span class="keywordtype">void</span> SetUsbDevice(Usb::Device *dev, <span class="keywordtype">int</span> writeEp, <span class="keywordtype">int</span> readEp, <a name="l00158"></a>00158 SocketDataHandlerPtr callback = SocketDataHandlerPtr()); <a name="l00159"></a>00159 <span class="keywordtype">void</span> ClearUsbDevice(); <a name="l00160"></a>00160 <span class="keywordtype">bool</span> UsbDeviceReady(); <a name="l00161"></a>00161 Usb::Device* GetUsbDevice() { <span class="keywordflow">return</span> m_dev; } <a name="l00162"></a>00162 <span class="keywordtype">void</span> ClearUsbError(); <a name="l00163"></a>00163 <a name="l00164"></a>00164 <a name="l00165"></a>00165 <span class="comment">// This class starts out with no buffers, and will grow one buffer</span> <a name="l00166"></a>00166 <span class="comment">// at a time if needed. Call this to allocate count buffers</span> <a name="l00167"></a>00167 <span class="comment">// all at once and place them on the free queue.</span> <a name="l00168"></a>00168 <span class="keywordtype">void</span> AllocateBuffers(<span class="keywordtype">int</span> count); <a name="l00169"></a>00169 <a name="l00170"></a>00170 <span class="comment">// Returns the data for the next unregistered socket.</span> <a name="l00171"></a>00171 <span class="comment">// Blocks until timeout or data is available.</span> <a name="l00172"></a>00172 <span class="comment">// Returns false (or null pointer) on timeout and no data.</span> <a name="l00173"></a>00173 <span class="comment">// With the return version of the function, there is no</span> <a name="l00174"></a>00174 <span class="comment">// copying performed.</span> <a name="l00175"></a>00175 <span class="comment">//</span> <a name="l00176"></a>00176 <span class="comment">// Timeout is in milliseconds. Default timeout set by constructor</span> <a name="l00177"></a>00177 <span class="comment">// is used if set to -1.</span> <a name="l00178"></a>00178 <span class="keywordtype">bool</span> DefaultRead(Data &receive, <span class="keywordtype">int</span> timeout = -1); <a name="l00179"></a>00179 DataHandle DefaultRead(<span class="keywordtype">int</span> timeout = -1); <a name="l00180"></a>00180 <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">// Any non-registered socket goes in the default queue</span> <a name="l00184"></a>00184 <span class="comment">// and must be read by DefaultRead()</span> <a name="l00185"></a>00185 <span class="comment">// If not null, handler is called when new data is read. It will</span> <a name="l00186"></a>00186 <span class="comment">// be called in the same thread instance that DoRead() is called from.</span> <a name="l00187"></a>00187 <span class="comment">// Handler is passed the DataQueue Data object, and so no</span> <a name="l00188"></a>00188 <span class="comment">// copying is done. Once the handler returns, the data is</span> <a name="l00189"></a>00189 <span class="comment">// considered processed and not added to the interested queue,</span> <a name="l00190"></a>00190 <span class="comment">// but instead returned to m_free.</span> <a name="l00191"></a>00191 <span class="keywordtype">void</span> RegisterInterest(SocketId socket, SocketDataHandlerPtr handler); <a name="l00192"></a>00192 <a name="l00193"></a>00193 <span class="comment">// Unregisters interest in data from the given socket, and discards</span> <a name="l00194"></a>00194 <span class="comment">// any existing data in its interest queue. Any new incoming data</span> <a name="l00195"></a>00195 <span class="comment">// for this socket will be placed in the default queue.</span> <a name="l00196"></a>00196 <span class="keywordtype">void</span> UnregisterInterest(SocketId socket); <a name="l00197"></a>00197 <a name="l00198"></a>00198 <span class="comment">// Reads data from the interested socket cache. Can only read</span> <a name="l00199"></a>00199 <span class="comment">// from sockets that have been previously registered.</span> <a name="l00200"></a>00200 <span class="comment">// Blocks until timeout or data is available.</span> <a name="l00201"></a>00201 <span class="comment">// Returns false (or null pointer) on timeout and no data.</span> <a name="l00202"></a>00202 <span class="comment">// With the return version of the function, there is no</span> <a name="l00203"></a>00203 <span class="comment">// copying performed.</span> <a name="l00204"></a>00204 <span class="comment">//</span> <a name="l00205"></a>00205 <span class="comment">// Timeout is in milliseconds. Default timeout set by constructor</span> <a name="l00206"></a>00206 <span class="comment">// is used if set to -1.</span> <a name="l00207"></a>00207 <span class="keywordtype">bool</span> SocketRead(SocketId socket, Data &receive, <span class="keywordtype">int</span> timeout = -1); <a name="l00208"></a>00208 DataHandle SocketRead(SocketId socket, <span class="keywordtype">int</span> timeout = -1); <a name="l00209"></a>00209 <a name="l00210"></a>00210 <span class="comment">// Returns true if data is available for that socket.</span> <a name="l00211"></a>00211 <span class="keywordtype">bool</span> IsAvailable(SocketId socket) <span class="keyword">const</span>; <a name="l00212"></a>00212 <a name="l00213"></a>00213 <span class="comment">// Called by the application's "read thread" to read the next usb</span> <a name="l00214"></a>00214 <span class="comment">// packet and route it to the correct queue. Returns after every</span> <a name="l00215"></a>00215 <span class="comment">// read, even if a handler is associated with a queue.</span> <a name="l00216"></a>00216 <span class="comment">// Note: this function is safe to call before SetUsbDevice() is</span> <a name="l00217"></a>00217 <span class="comment">// called... it just doesn't do anything if there is no usb</span> <a name="l00218"></a>00218 <span class="comment">// device to work with.</span> <a name="l00219"></a>00219 <span class="comment">//</span> <a name="l00220"></a>00220 <span class="comment">// Timeout is in milliseconds. Default is default USB timeout.</span> <a name="l00221"></a>00221 <span class="keywordtype">void</span> DoRead(<span class="keywordtype">int</span> timeout = -1); <a name="l00222"></a>00222 <a name="l00223"></a>00223 <span class="comment">// Utility function to make it easier for the user to create the</span> <a name="l00224"></a>00224 <span class="comment">// USB pure-read thread. If the user wants anything more complicated</span> <a name="l00225"></a>00225 <span class="comment">// in this background thread, he can implement it himself and call</span> <a name="l00226"></a>00226 <span class="comment">// the above DoRead() in a loop. If only the basics are needed,</span> <a name="l00227"></a>00227 <span class="comment">// then this makes it easy.</span> <a name="l00228"></a>00228 <span class="comment">// Throws Barry::ErrnoError on thread creation error.</span> <a name="l00229"></a>00229 <span class="keywordtype">void</span> SpinoffSimpleReadThread(); <a name="l00230"></a>00230 }; <a name="l00231"></a>00231 <a name="l00232"></a>00232 <a name="l00233"></a>00233 <span class="comment">//</span> <a name="l00234"></a>00234 <span class="comment">// DataHandle</span> <a name="l00235"></a>00235 <span class="comment">//</span><span class="comment"></span> <a name="l00236"></a>00236 <span class="comment">/// std::auto_ptr like class that handles pointers to Data, but instead of</span> <a name="l00237"></a>00237 <span class="comment">/// freeing them completely, the Data objects are turned to the</span> <a name="l00238"></a>00238 <span class="comment">/// SocketRoutingQueue from whence they came.</span> <a name="l00239"></a>00239 <span class="comment">///</span> <a name="l00240"></a><a class="code" href="classBarry_1_1DataHandle.html">00240</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <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 name="l00241"></a>00241 { <a name="l00242"></a>00242 <span class="keyword">private</span>: <a name="l00243"></a>00243 SocketRoutingQueue &m_queue; <a name="l00244"></a>00244 <span class="keyword">mutable</span> Data *m_data; <a name="l00245"></a>00245 <a name="l00246"></a>00246 <span class="keyword">protected</span>: <a name="l00247"></a>00247 <span class="keywordtype">void</span> clear() <a name="l00248"></a>00248 { <a name="l00249"></a>00249 <span class="keywordflow">if</span>( m_data ) { <a name="l00250"></a>00250 m_queue.ReturnBuffer(m_data); <a name="l00251"></a>00251 m_data = 0; <a name="l00252"></a>00252 } <a name="l00253"></a>00253 } <a name="l00254"></a>00254 <a name="l00255"></a>00255 <span class="keyword">public</span>: <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>(SocketRoutingQueue &q, Data *data) <a name="l00257"></a>00257 : m_queue(q) <a name="l00258"></a>00258 , m_data(data) <a name="l00259"></a>00259 { <a name="l00260"></a>00260 } <a name="l00261"></a>00261 <a name="l00262"></a>00262 <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">const</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> &other) <a name="l00263"></a>00263 : m_queue(other.<a class="code" href="classBarry_1_1DataHandle.html#50e8ef518c31008098ba5d2800f0cb60">m_queue</a>) <a name="l00264"></a>00264 , m_data(other.<a class="code" href="classBarry_1_1DataHandle.html#7d9f19fbb2b052b0f8848e9b3bf88755">m_data</a>) <a name="l00265"></a>00265 { <a name="l00266"></a>00266 <span class="comment">// we now own the pointer</span> <a name="l00267"></a>00267 other.<a class="code" href="classBarry_1_1DataHandle.html#7d9f19fbb2b052b0f8848e9b3bf88755">m_data</a> = 0; <a name="l00268"></a>00268 } <a name="l00269"></a>00269 <a name="l00270"></a>00270 ~<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 name="l00271"></a>00271 { <a name="l00272"></a>00272 clear(); <a name="l00273"></a>00273 } <a name="l00274"></a>00274 <a name="l00275"></a>00275 Data* <span class="keyword">get</span>() <a name="l00276"></a>00276 { <a name="l00277"></a>00277 <span class="keywordflow">return</span> m_data; <a name="l00278"></a>00278 } <a name="l00279"></a>00279 <a name="l00280"></a>00280 Data* release() <span class="comment">// no longer owns the pointer</span> <a name="l00281"></a>00281 { <a name="l00282"></a>00282 Data *ret = m_data; <a name="l00283"></a>00283 m_data = 0; <a name="l00284"></a>00284 <span class="keywordflow">return</span> ret; <a name="l00285"></a>00285 } <a name="l00286"></a>00286 <a name="l00287"></a>00287 Data* operator->() <a name="l00288"></a>00288 { <a name="l00289"></a>00289 <span class="keywordflow">return</span> m_data; <a name="l00290"></a>00290 } <a name="l00291"></a>00291 <a name="l00292"></a>00292 <span class="keyword">const</span> Data* operator->()<span class="keyword"> const</span> <a name="l00293"></a>00293 <span class="keyword"> </span>{ <a name="l00294"></a>00294 <span class="keywordflow">return</span> m_data; <a name="l00295"></a>00295 } <a name="l00296"></a>00296 <a name="l00297"></a>00297 <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>& operator=(<span class="keyword">const</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> &other) <a name="l00298"></a>00298 { <a name="l00299"></a>00299 <span class="keywordflow">if</span>( &m_queue != &other.<a class="code" href="classBarry_1_1DataHandle.html#50e8ef518c31008098ba5d2800f0cb60">m_queue</a> ) <a name="l00300"></a>00300 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Trying to copy DataHandles of different queues!"</span>); <a name="l00301"></a>00301 <a name="l00302"></a>00302 <span class="comment">// remove our current data</span> <a name="l00303"></a>00303 clear(); <a name="l00304"></a>00304 <a name="l00305"></a>00305 <span class="comment">// accept the new</span> <a name="l00306"></a>00306 m_data = other.<a class="code" href="classBarry_1_1DataHandle.html#7d9f19fbb2b052b0f8848e9b3bf88755">m_data</a>; <a name="l00307"></a>00307 <a name="l00308"></a>00308 <span class="comment">// we now own it</span> <a name="l00309"></a>00309 other.<a class="code" href="classBarry_1_1DataHandle.html#7d9f19fbb2b052b0f8848e9b3bf88755">m_data</a> = 0; <a name="l00310"></a>00310 <a name="l00311"></a>00311 <span class="keywordflow">return</span> *<span class="keyword">this</span>; <a name="l00312"></a>00312 } <a name="l00313"></a>00313 <a name="l00314"></a>00314 }; <a name="l00315"></a>00315 <a name="l00316"></a>00316 <a name="l00317"></a>00317 } <span class="comment">// namespace Barry</span> <a name="l00318"></a>00318 <a name="l00319"></a>00319 <span class="preprocessor">#endif</span> <a name="l00320"></a>00320 <span class="preprocessor"></span> </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>