<!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::Socket 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_1Socket.html">Socket</a>
</div>
</div>
<div class="contents">
<h1>Barry::Socket Class Reference</h1><!-- doxytag: class="Barry::Socket" -->
<p>Encapsulates a "logical socket" in the Blackberry USB protocol.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for Barry::Socket:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Socket__coll__graph.png" border="0" usemap="#Barry_1_1Socket_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1Socket_coll__map" id="Barry_1_1Socket_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1SocketZero.html" title="Barry::SocketZero" alt="" coords="49,419,180,450"/><area shape="rect" id="node4" href="classUsb_1_1Device.html" title="Usb::Device" alt="" coords="5,203,101,234"/><area shape="rect" id="node6" href="classBarry_1_1SocketRoutingQueue.html" title="Barry::SocketRoutingQueue" alt="" coords="136,321,325,351"/><area shape="rect" id="node11" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory..." alt="" coords="392,203,523,234"/><area shape="rect" id="node15" href="classBarry_1_1Data.html" title="Barry::Data" alt="" coords="412,6,503,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classBarry_1_1Socket-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Socket.html#ab6d54691a29351ac15eddbfc35e7fe50">Send</a> (<a class="el" href="classBarry_1_1Data.html">Data</a> &send, int timeout=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends 'send' data to device, no receive. <a href="#ab6d54691a29351ac15eddbfc35e7fe50"></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_1Socket.html#a0bfdaaf739cc692d96d73a8781197423">Send</a> (<a class="el" href="classBarry_1_1Data.html">Data</a> &send, <a class="el" href="classBarry_1_1Data.html">Data</a> &receive, int timeout=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends 'send' data to device, and waits for response. <a href="#a0bfdaaf739cc692d96d73a8781197423"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Encapsulates a "logical socket" in the Blackberry USB protocol. </p>
<p>By default, provides raw send/receive access, as well as packet writing on socket 0, which is always open.</p>
<p>There are Open and Close members to open data sockets which are used to transfer data to and from the device.</p>
<p>The destructor will close any non-0 open sockets automatically.</p>
<p>Requires an active <a class="el" href="classUsb_1_1Device.html">Usb::Device</a> object to work on. </p>
<p>Definition at line <a class="el" href="socket_8h_source.html#l00131">131</a> of file <a class="el" href="socket_8h_source.html">socket.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0bfdaaf739cc692d96d73a8781197423"></a><!-- doxytag: member="Barry::Socket::Send" ref="a0bfdaaf739cc692d96d73a8781197423" args="(Data &send, Data &receive, int timeout=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::Socket::Send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1Data.html">Data</a> & </td>
<td class="paramname"> <em>send</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>receive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends 'send' data to device, and waits for response. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>void</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a></em> </td><td>on underlying bus errors. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="socket_8cc_source.html#l00702">702</a> of file <a class="el" href="socket_8cc_source.html">socket.cc</a>.</p>
<p>References <a class="el" href="socket_8cc_source.html#l00683">Send()</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_1Socket_a0bfdaaf739cc692d96d73a8781197423_cgraph.png" border="0" usemap="#classBarry_1_1Socket_a0bfdaaf739cc692d96d73a8781197423_cgraph_map" alt=""></div>
<map name="classBarry_1_1Socket_a0bfdaaf739cc692d96d73a8781197423_cgraph_map" id="classBarry_1_1Socket_a0bfdaaf739cc692d96d73a8781197423_cgraph">
<area shape="rect" id="node3" href="classBarry_1_1Socket.html#ab6d54691a29351ac15eddbfc35e7fe50" title="Sends 'send' data to device, no receive." alt="" coords="197,5,341,35"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ab6d54691a29351ac15eddbfc35e7fe50"></a><!-- doxytag: member="Barry::Socket::Send" ref="ab6d54691a29351ac15eddbfc35e7fe50" args="(Data &send, int timeout=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Barry::Socket::Send </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBarry_1_1Data.html">Data</a> & </td>
<td class="paramname"> <em>send</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends 'send' data to device, no receive. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>void</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a></em> </td><td>on underlying bus errors. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="socket_8cc_source.html#l00683">683</a> of file <a class="el" href="socket_8cc_source.html">socket.cc</a>.</p>
<p>Referenced by <a class="el" href="socket_8cc_source.html#l00702">Send()</a>.</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1Socket_ab6d54691a29351ac15eddbfc35e7fe50_icgraph.png" border="0" usemap="#classBarry_1_1Socket_ab6d54691a29351ac15eddbfc35e7fe50_icgraph_map" alt=""></div>
<map name="classBarry_1_1Socket_ab6d54691a29351ac15eddbfc35e7fe50_icgraph_map" id="classBarry_1_1Socket_ab6d54691a29351ac15eddbfc35e7fe50_icgraph">
<area shape="rect" id="node3" href="classBarry_1_1Socket.html#a0bfdaaf739cc692d96d73a8781197423" title="Sends 'send' data to device, and waits for response." alt="" coords="197,5,341,35"/></map>
</div>
</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="socket_8h_source.html">socket.h</a></li>
<li><a class="el" href="socket_8cc_source.html">socket.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>
