<!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::Mode::JavaLoader 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>::<b>Mode</b>::<a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html">JavaLoader</a>
</div>
</div>
<div class="contents">
<h1>Barry::Mode::JavaLoader Class Reference</h1><!-- doxytag: class="Barry::Mode::JavaLoader" --><!-- doxytag: inherits="Barry::Mode::Mode" -->
<p>The main interface class to the java program loader protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="m__javaloader_8h_source.html">m_javaloader.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Barry::Mode::JavaLoader:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Mode_1_1JavaLoader__inherit__graph.png" border="0" usemap="#Barry_1_1Mode_1_1JavaLoader_inherit__map" alt="Inheritance graph"/></div>
<map name="Barry_1_1Mode_1_1JavaLoader_inherit__map" id="Barry_1_1Mode_1_1JavaLoader_inherit__map">
<area shape="rect" id="node2" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="25,6,164,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Barry::Mode::JavaLoader:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Mode_1_1JavaLoader__coll__graph.png" border="0" usemap="#Barry_1_1Mode_1_1JavaLoader_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1Mode_1_1JavaLoader_coll__map" id="Barry_1_1Mode_1_1JavaLoader_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes." alt="" coords="1897,297,2036,327"/><area shape="rect" id="node4" href="classBarry_1_1Controller.html" title="The main interface class." alt="" coords="1443,265,1563,295"/><area shape="rect" id="node6" href="classBarry_1_1Pin.html" title="Barry::Pin" alt="" coords="908,5,988,35"/><area shape="rect" id="node10" href="structBarry_1_1ProbeResult.html" title="Barry::ProbeResult" alt="" coords="1209,110,1343,141"/><area shape="rect" id="node8" href="classUsb_1_1Device.html" title="Usb::Device" alt="" coords="529,287,625,318"/><area shape="rect" id="node19" href="classBarry_1_1SocketZero.html" title="Barry::SocketZero" alt="" coords="1211,334,1341,365"/><area shape="rect" id="node22" href="classBarry_1_1SocketRoutingQueue.html" title="Barry::SocketRoutingQueue" alt="" coords="853,398,1043,429"/><area shape="rect" id="node33" href="classUsb_1_1Interface.html" title="Usb::Interface" alt="" coords="1073,262,1177,293"/><area shape="rect" id="node12" href="structUsb_1_1EndpointPair.html" title="Usb::EndpointPair" alt="" coords="885,91,1011,122"/><area shape="rect" id="node15" title="STL class." alt="" coords="908,157,988,187"/><area shape="rect" id="node17" title="STL class." alt="" coords="493,157,661,187"/><area shape="rect" id="node39" href="classBarry_1_1Socket.html" title="Encapsulates a "logical socket" in the Blackberry USB protocol." alt="" coords="1451,350,1555,381"/><area shape="rect" id="node27" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory..." alt="" coords="512,419,643,450"/><area shape="rect" id="node31" href="classBarry_1_1Data.html" title="Barry::Data" alt="" coords="5,419,96,450"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1Mode_1_1JavaLoader-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html#aadb74f46b334a4b1ab17b9e060a63997">StopStream</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Must be called at the end of a <a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">JavaLoader</a> session. <a href="#aadb74f46b334a4b1ab17b9e060a63997"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html#a237c4ac1e59f5bbcfc57a7e6eec1cf11">GetScreenshot</a> (<a class="el" href="classBarry_1_1JLScreenInfo.html">JLScreenInfo</a> &info, <a class="el" href="classBarry_1_1Data.html">Data</a> &image)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Downloads screenshot from device, and fills info with size data and the given <a class="el" href="classBarry_1_1Data.html">Data</a> buffer image with the bitmap. <a href="#a237c4ac1e59f5bbcfc57a7e6eec1cf11"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The main interface class to the java program loader protocol. </p>
<p>To use this class, use the following steps:</p>
<ul>
<li>Create a <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> object (see <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> class for more details)</li>
<li>Create this <a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">Mode::JavaLoader</a> object, passing in the <a class="el" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> object during construction</li>
<li>Call <a class="el" href="classBarry_1_1Mode_1_1Mode.html#a1110243f16be2b647ed9810da27abe11" title="Select device mode.">Open()</a> to open database socket and finish constructing.</li>
<li>Call LoadDatabase() to retrieve and store a database </li>
</ul>
<p>Definition at line <a class="el" href="m__javaloader_8h_source.html#l00220">220</a> of file <a class="el" href="m__javaloader_8h_source.html">m_javaloader.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a237c4ac1e59f5bbcfc57a7e6eec1cf11"></a><!-- doxytag: member="Barry::Mode::JavaLoader::GetScreenshot" ref="a237c4ac1e59f5bbcfc57a7e6eec1cf11" args="(JLScreenInfo &info, Data &image)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::Mode::JavaLoader::GetScreenshot </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1JLScreenInfo.html">JLScreenInfo</a> & </td>
<td class="paramname"> <em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBarry_1_1Data.html">Data</a> & </td>
<td class="paramname"> <em>image</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Downloads screenshot from device, and fills info with size data and the given <a class="el" href="classBarry_1_1Data.html">Data</a> buffer image with the bitmap. </p>
<p>Definition at line <a class="el" href="m__javaloader_8cc_source.html#l00615">615</a> of file <a class="el" href="m__javaloader_8cc_source.html">m_javaloader.cc</a>.</p>
<p>References <a class="el" href="packet_8cc_source.html#l00050">Barry::Packet::Command()</a>, and <a class="el" href="data_8cc_source.html#l00263">Barry::Data::Zap()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Mode_1_1JavaLoader_a237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph.png" border="0" usemap="#classBarry_1_1Mode_1_1JavaLoader_a237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph_map" alt=""></div>
<map name="classBarry_1_1Mode_1_1JavaLoader_a237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph_map" id="classBarry_1_1Mode_1_1JavaLoader_a237c4ac1e59f5bbcfc57a7e6eec1cf11_cgraph">
<area shape="rect" id="node3" href="classBarry_1_1Packet.html#a764cefd38c2dc1970fccabc01044687d" title="Returns the command value of the receive packet." alt="" coords="332,5,505,35"/><area shape="rect" id="node5" href="classBarry_1_1Data.html#a034f95733ad4e34a3a3f3be874f3c555" title="set buffer to 0 and remove all data" alt="" coords="357,58,480,89"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aadb74f46b334a4b1ab17b9e060a63997"></a><!-- doxytag: member="Barry::Mode::JavaLoader::StopStream" ref="aadb74f46b334a4b1ab17b9e060a63997" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Barry::Mode::JavaLoader::StopStream </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Must be called at the end of a <a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">JavaLoader</a> session. </p>
<p>The JL_GOODBYE command is sent to the device. When the device responds with RESET_REQUIRED the device reset command will be sent when the socket is closed.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true when a device reset was required </dd></dl>
<p>Definition at line <a class="el" href="m__javaloader_8cc_source.html#l00474">474</a> of file <a class="el" href="m__javaloader_8cc_source.html">m_javaloader.cc</a>.</p>
<p>References <a class="el" href="packet_8cc_source.html#l00050">Barry::Packet::Command()</a>.</p>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Mode_1_1JavaLoader_aadb74f46b334a4b1ab17b9e060a63997_cgraph.png" border="0" usemap="#classBarry_1_1Mode_1_1JavaLoader_aadb74f46b334a4b1ab17b9e060a63997_cgraph_map" alt=""></div>
<map name="classBarry_1_1Mode_1_1JavaLoader_aadb74f46b334a4b1ab17b9e060a63997_cgraph_map" id="classBarry_1_1Mode_1_1JavaLoader_aadb74f46b334a4b1ab17b9e060a63997_cgraph">
<area shape="rect" id="node3" href="classBarry_1_1Packet.html#a764cefd38c2dc1970fccabc01044687d" title="Returns the command value of the receive packet." alt="" coords="311,5,484,35"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="m__javaloader_8h_source.html">m_javaloader.h</a></li>
<li><a class="el" href="m__javaloader_8cc_source.html">m_javaloader.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>
