<!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: Barry::Socket Class Reference</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 class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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" --><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">
<p><center><img src="classBarry_1_1Socket__coll__graph.png" border="0" usemap="#Barry_1_1Socket__coll__map" alt="Collaboration graph"></center>
<map name="Barry_1_1Socket__coll__map">
<area shape="rect" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory..." alt="" coords="131,5,256,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classBarry_1_1Socket-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Encapsulates a "logical socket" in the Blackberry USB protocol.
<p>
By default, provides raw send/receive access, as well as packet writing on socket 0, which is always open.<p>
There are Open and Close members to open data sockets which are used to transfer data to and from the device.<p>
The destructor will close any non-0 open sockets automatically.<p>
Requires an active Usb::Device object to work on.
<p>Definition at line <a class="el" href="socket_8h-source.html#l00132">132</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50">Send</a> (Data &send, int timeout=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends 'send' data to device, no receive. <a href="#b6d54691a29351ac15eddbfc35e7fe50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Socket.html#0bfdaaf739cc692d96d73a8781197423">Send</a> (Data &send, Data &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="#0bfdaaf739cc692d96d73a8781197423"></a><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b6d54691a29351ac15eddbfc35e7fe50"></a><!-- doxytag: member="Barry::Socket::Send" ref="b6d54691a29351ac15eddbfc35e7fe50" 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">Data & </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" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
<dl compact><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>
</dl>
<p>Definition at line <a class="el" href="socket_8cc-source.html#l00713">713</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#l00732">Send()</a>.</p>
<p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph.png" border="0" usemap="#classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph_map" alt=""></center>
<map name="classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph_map">
<area shape="rect" href="classBarry_1_1Socket.html#0bfdaaf739cc692d96d73a8781197423" title="Sends 'send' data to device, and waits for response." alt="" coords="196,5,335,32"></map>
</div>
</div>
</div><p>
<a class="anchor" name="0bfdaaf739cc692d96d73a8781197423"></a><!-- doxytag: member="Barry::Socket::Send" ref="0bfdaaf739cc692d96d73a8781197423" 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">Data & </td>
<td class="paramname"> <em>send</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Data & </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" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
<dl compact><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>
</dl>
<p>Definition at line <a class="el" href="socket_8cc-source.html#l00732">732</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#l00713">Send()</a>.</p>
<p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<p><center><img src="classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph.png" border="0" usemap="#classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph_map" alt=""></center>
<map name="classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph_map">
<area shape="rect" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends 'send' data to device, no receive." alt="" coords="196,5,335,32"></map>
</div>
</div>
</div><p>
<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><a class="el" href="socket_8cc-source.html">socket.cc</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:51:04 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>
