<!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: Barry::Controller Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1Controller.html">Controller</a>
</div>
</div>
<div class="contents">
<h1>Barry::Controller Class Reference</h1><!-- doxytag: class="Barry::Controller" -->
<p>The main interface class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="controller_8h_source.html">controller.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for Barry::Controller:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Controller__coll__graph.png" border="0" usemap="#Barry_1_1Controller_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1Controller_coll__map" id="Barry_1_1Controller_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Pin.html" title="Barry::Pin" alt="" coords="908,5,988,35"/><area shape="rect" id="node6" href="structBarry_1_1ProbeResult.html" title="Barry::ProbeResult" alt="" coords="1209,110,1343,141"/><area shape="rect" id="node4" href="classUsb_1_1Device.html" title="Usb::Device" alt="" coords="529,297,625,327"/><area shape="rect" id="node15" href="classBarry_1_1SocketZero.html" title="Barry::SocketZero" alt="" coords="1211,265,1341,295"/><area shape="rect" id="node18" href="classBarry_1_1SocketRoutingQueue.html" title="Barry::SocketRoutingQueue" alt="" coords="853,406,1043,437"/><area shape="rect" id="node29" href="classUsb_1_1Interface.html" title="Usb::Interface" alt="" coords="1073,322,1177,353"/><area shape="rect" id="node8" href="structUsb_1_1EndpointPair.html" title="Usb::EndpointPair" alt="" coords="885,158,1011,189"/><area shape="rect" id="node11" title="STL class." alt="" coords="908,91,988,122"/><area shape="rect" id="node13" title="STL class." alt="" coords="493,91,661,122"/><area shape="rect" id="node23" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory..." alt="" coords="512,442,643,473"/><area shape="rect" id="node27" href="classBarry_1_1Data.html" title="Barry::Data" alt="" coords="5,442,96,473"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1Controller-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#a8b40b5d7e285b39375d857e1cea6cb15">ModeType</a> </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Handheld mode type. </p>
<a href="classBarry_1_1Controller.html#a8b40b5d7e285b39375d857e1cea6cb15">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#affac40e1eb00e5cedc3f575a64828e6c">Controller</a> (const <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> &device, int default_timeout=USBWRAP_DEFAULT_TIMEOUT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class. <a href="#affac40e1eb00e5cedc3f575a64828e6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#a32fbca6195f9e4bf45419ea8d244ebdd">Controller</a> (const <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> &device, <a class="el" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> &queue, int default_timeout=USBWRAP_DEFAULT_TIMEOUT)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class. <a href="#a32fbca6195f9e4bf45419ea8d244ebdd"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d04dbe14f6107d975127a419876dd46"></a><!-- doxytag: member="Barry::Controller::Barry::Mode::Mode" ref="a8d04dbe14f6107d975127a419876dd46" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#a8d04dbe14f6107d975127a419876dd46">Barry::Mode::Mode</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab5b725bb1f49e97f97f4f806f48a5fa"></a><!-- doxytag: member="Barry::Controller::Barry::Mode::IpModem" ref="aab5b725bb1f49e97f97f4f806f48a5fa" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#aab5b725bb1f49e97f97f4f806f48a5fa">Barry::Mode::IpModem</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5d9d7642d3fcab8978d2333f8df1a58"></a><!-- doxytag: member="Barry::Controller::Barry::Mode::Serial" ref="aa5d9d7642d3fcab8978d2333f8df1a58" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#aa5d9d7642d3fcab8978d2333f8df1a58">Barry::Mode::Serial</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5dfdb73a8b9f132b5970ba6602ddbfb"></a><!-- doxytag: member="Barry::Controller::Barry::Mode::JavaLoader" ref="af5dfdb73a8b9f132b5970ba6602ddbfb" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#af5dfdb73a8b9f132b5970ba6602ddbfb">Barry::Mode::JavaLoader</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3e279f8c8a0eb5e722eea48b63999b3"></a><!-- doxytag: member="Barry::Controller::Barry::Mode::JVMDebug" ref="ae3e279f8c8a0eb5e722eea48b63999b3" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Controller.html#ae3e279f8c8a0eb5e722eea48b63999b3">Barry::Mode::JVMDebug</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The main interface class. </p>
<p>This class coordinates the communication to a single handheld. This class also owns the only <a class="el" href="classUsb_1_1Device.html">Usb::Device</a> object the handheld. All other classes reference this one for the low level device object. This class owns the only <a class="el" href="classBarry_1_1SocketZero.html">SocketZero</a> object as well, which is the object that any <a class="el" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> is plugged into if constructed that way.</p>
<p>To use this class, use the following steps:</p>
<ul>
<li><a class="el" href="classBarry_1_1Probe.html">Probe</a> the USB bus for matching devices with the <a class="el" href="classBarry_1_1Probe.html">Probe</a> class</li>
<li>Create an optional <a class="el" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> object and create a read thread for it, or use its default read thread.</li>
<li>Pass one of the probe results into the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> constructor to connect to the USB device. Pass the routing queue to the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> constructor here too, if needed.</li>
<li>Create the Mode object of your choice. See <a class="el" href="m__desktop_8h.html" title="Mode class for the Desktop mode.">m_desktop.h</a> and <a class="el" href="m__serial_8h.html" title="Mode class for serial / GPRS modem mode.">m_serial.h</a> for these mode classes. You pass your controller object into these mode constructors to create the mode. </li>
</ul>
<p>Definition at line <a class="el" href="controller_8h_source.html#l00070">70</a> of file <a class="el" href="controller_8h_source.html">controller.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a8b40b5d7e285b39375d857e1cea6cb15"></a><!-- doxytag: member="Barry::Controller::ModeType" ref="a8b40b5d7e285b39375d857e1cea6cb15" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classBarry_1_1Controller.html#a8b40b5d7e285b39375d857e1cea6cb15">Barry::Controller::ModeType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handheld mode type. </p>
<p>Definition at line <a class="el" href="controller_8h_source.html#l00080">80</a> of file <a class="el" href="controller_8h_source.html">controller.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="affac40e1eb00e5cedc3f575a64828e6c"></a><!-- doxytag: member="Barry::Controller::Controller" ref="affac40e1eb00e5cedc3f575a64828e6c" args="(const ProbeResult &device, int default_timeout=USBWRAP_DEFAULT_TIMEOUT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Barry::Controller::Controller </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> & </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>default_timeout</em> = <code>USBWRAP_DEFAULT_TIMEOUT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class. </p>
<p>Requires a valid <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> object to find the USB device to talk to.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>device</em> </td><td>One of the <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> objects from the <a class="el" href="classBarry_1_1Probe.html">Probe</a> class. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>default_timeout</em> </td><td>Override <a class="el" href="classUsb_1_1Device.html">Usb::Device</a>'s default timeout </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="controller_8cc_source.html#l00046">46</a> of file <a class="el" href="controller_8cc_source.html">controller.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a32fbca6195f9e4bf45419ea8d244ebdd"></a><!-- doxytag: member="Barry::Controller::Controller" ref="a32fbca6195f9e4bf45419ea8d244ebdd" args="(const ProbeResult &device, SocketRoutingQueue &queue, int default_timeout=USBWRAP_DEFAULT_TIMEOUT)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Barry::Controller::Controller </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> & </td>
<td class="paramname"> <em>device</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> & </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>default_timeout</em> = <code>USBWRAP_DEFAULT_TIMEOUT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class. </p>
<p>Requires a valid <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> object to find the USB device to talk to.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>device</em> </td><td>One of the <a class="el" href="structBarry_1_1ProbeResult.html">ProbeResult</a> objects from the <a class="el" href="classBarry_1_1Probe.html">Probe</a> class. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>queue</em> </td><td>Plugin router object for reading data from sockets. </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>default_timeout</em> </td><td>Override <a class="el" href="classUsb_1_1Device.html">Usb::Device</a>'s default timeout </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="controller_8cc_source.html#l00071">71</a> of file <a class="el" href="controller_8cc_source.html">controller.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="controller_8h_source.html">controller.h</a></li>
<li><a class="el" href="controller_8cc_source.html">controller.cc</a></li>
</ul>
</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>
