doc/www/doxygen/html/classBarry_1_1Socket.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Barry::Socket Class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27   <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1Socket.html">Socket</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::Socket Class Reference</h1><!-- doxytag: class="Barry::Socket" --><code>#include &lt;<a class="el" href="socket_8h-source.html">socket.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Collaboration diagram for Barry::Socket:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1Socket__coll__graph.png" border="0" usemap="#Barry_1_1Socket__coll__map" alt="Collaboration graph"></center>
  37 <map name="Barry_1_1Socket__coll__map">
  38 <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>
  39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  40
  41 <p>
  42 <a href="classBarry_1_1Socket-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  43 Encapsulates a "logical socket" in the Blackberry USB protocol.
  44 <p>
  45 By default, provides raw send/receive access, as well as packet writing on socket 0, which is always open.<p>
  46 There are Open and Close members to open data sockets which are used to transfer data to and from the device.<p>
  47 The destructor will close any non-0 open sockets automatically.<p>
  48 Requires an active Usb::Device object to work on.
  49 <p>Definition at line <a class="el" href="socket_8h-source.html#l00127">127</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.</p>
  50 <table border="0" cellpadding="0" cellspacing="0">
  51 <tr><td></td></tr>
  52 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  53 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50">Send</a> (Data &amp;send, int timeout=-1)</td></tr>
  54
  55 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends 'send' data to device, no receive.  <a href="#b6d54691a29351ac15eddbfc35e7fe50"></a><br></td></tr>
  56 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1Socket.html#0bfdaaf739cc692d96d73a8781197423">Send</a> (Data &amp;send, Data &amp;receive, int timeout=-1)</td></tr>
  57
  58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sends 'send' data to device, and waits for response.  <a href="#0bfdaaf739cc692d96d73a8781197423"></a><br></td></tr>
  59 </table>
  60 <hr><h2>Member Function Documentation</h2>
  61 <a class="anchor" name="b6d54691a29351ac15eddbfc35e7fe50"></a><!-- doxytag: member="Barry::Socket::Send" ref="b6d54691a29351ac15eddbfc35e7fe50" args="(Data &amp;send, int timeout=-1)" -->
  62 <div class="memitem">
  63 <div class="memproto">
  64       <table class="memname">
  65         <tr>
  66           <td class="memname">void Barry::Socket::Send           </td>
  67           <td>(</td>
  68           <td class="paramtype">Data &amp;&nbsp;</td>
  69           <td class="paramname"> <em>send</em>, </td>
  70         </tr>
  71         <tr>
  72           <td class="paramkey"></td>
  73           <td></td>
  74           <td class="paramtype">int&nbsp;</td>
  75           <td class="paramname"> <em>timeout</em> = <code>-1</code></td><td>&nbsp;</td>
  76         </tr>
  77         <tr>
  78           <td></td>
  79           <td>)</td>
  80           <td></td><td></td><td></td>
  81         </tr>
  82       </table>
  83 </div>
  84 <div class="memdoc">
  85
  86 <p>
  87 Sends 'send' data to device, no receive.
  88 <p>
  89 <dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
  90 <dl compact><dt><b>Exceptions:</b></dt><dd>
  91   <table border="0" cellspacing="2" cellpadding="0">
  92     <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>&nbsp;</td><td>on underlying bus errors. </td></tr>
  93   </table>
  94 </dl>
  95
  96 <p>Definition at line <a class="el" href="socket_8cc-source.html#l00663">663</a> of file <a class="el" href="socket_8cc-source.html">socket.cc</a>.</p>
  97
  98 <p>Referenced by <a class="el" href="socket_8cc-source.html#l00682">Send()</a>.</p>
  99
 100 <p>
 101 <div class="dynheader">
 102 Here is the caller graph for this function:</div>
 103 <div class="dynsection">
 104 <p><center><img src="classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph.png" border="0" usemap="#classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph_map" alt=""></center>
 105 <map name="classBarry_1_1Socket_b6d54691a29351ac15eddbfc35e7fe50_icgraph_map">
 106 <area shape="rect" href="classBarry_1_1Socket.html#0bfdaaf739cc692d96d73a8781197423" title="Sends &#39;send&#39; data to device, and waits for response." alt="" coords="196,5,335,32"></map>
 107 </div>
 108
 109 </div>
 110 </div><p>
 111 <a class="anchor" name="0bfdaaf739cc692d96d73a8781197423"></a><!-- doxytag: member="Barry::Socket::Send" ref="0bfdaaf739cc692d96d73a8781197423" args="(Data &amp;send, Data &amp;receive, int timeout=-1)" -->
 112 <div class="memitem">
 113 <div class="memproto">
 114       <table class="memname">
 115         <tr>
 116           <td class="memname">void Barry::Socket::Send           </td>
 117           <td>(</td>
 118           <td class="paramtype">Data &amp;&nbsp;</td>
 119           <td class="paramname"> <em>send</em>, </td>
 120         </tr>
 121         <tr>
 122           <td class="paramkey"></td>
 123           <td></td>
 124           <td class="paramtype">Data &amp;&nbsp;</td>
 125           <td class="paramname"> <em>receive</em>, </td>
 126         </tr>
 127         <tr>
 128           <td class="paramkey"></td>
 129           <td></td>
 130           <td class="paramtype">int&nbsp;</td>
 131           <td class="paramname"> <em>timeout</em> = <code>-1</code></td><td>&nbsp;</td>
 132         </tr>
 133         <tr>
 134           <td></td>
 135           <td>)</td>
 136           <td></td><td></td><td></td>
 137         </tr>
 138       </table>
 139 </div>
 140 <div class="memdoc">
 141
 142 <p>
 143 Sends 'send' data to device, and waits for response.
 144 <p>
 145 <dl class="return" compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
 146 <dl compact><dt><b>Exceptions:</b></dt><dd>
 147   <table border="0" cellspacing="2" cellpadding="0">
 148     <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>&nbsp;</td><td>on underlying bus errors. </td></tr>
 149   </table>
 150 </dl>
 151
 152 <p>Definition at line <a class="el" href="socket_8cc-source.html#l00682">682</a> of file <a class="el" href="socket_8cc-source.html">socket.cc</a>.</p>
 153
 154 <p>References <a class="el" href="socket_8cc-source.html#l00663">Send()</a>.</p>
 155
 156 <p>
 157 <div class="dynheader">
 158 Here is the call graph for this function:</div>
 159 <div class="dynsection">
 160 <p><center><img src="classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph.png" border="0" usemap="#classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph_map" alt=""></center>
 161 <map name="classBarry_1_1Socket_0bfdaaf739cc692d96d73a8781197423_cgraph_map">
 162 <area shape="rect" href="classBarry_1_1Socket.html#b6d54691a29351ac15eddbfc35e7fe50" title="Sends &#39;send&#39; data to device, no receive." alt="" coords="196,5,335,32"></map>
 163 </div>
 164
 165 </div>
 166 </div><p>
 167 <hr>The documentation for this class was generated from the following files:<ul>
 168 <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>
 169 </div>
 170 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:02:17 2009 for Barry by&nbsp;
 171 <a href="http://www.doxygen.org/index.html">
 172 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 173 </body>
 174 </html>