doc/www/doxygen/html/classBarry_1_1ZeroPacket.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::ZeroPacket 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_1ZeroPacket.html">ZeroPacket</a>
  28   </div>
  29 </div>
  30 <div class="contents">
  31 <h1>Barry::ZeroPacket Class Reference</h1><!-- doxytag: class="Barry::ZeroPacket" --><!-- doxytag: inherits="Barry::Packet" --><code>#include &lt;<a class="el" href="packet_8h-source.html">packet.h</a>&gt;</code>
  32 <p>
  33 <div class="dynheader">
  34 Inheritance diagram for Barry::ZeroPacket:</div>
  35 <div class="dynsection">
  36 <p><center><img src="classBarry_1_1ZeroPacket__inherit__graph.png" border="0" usemap="#Barry_1_1ZeroPacket__inherit__map" alt="Inheritance graph"></center>
  37 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  38 <div class="dynheader">
  39 Collaboration diagram for Barry::ZeroPacket:</div>
  40 <div class="dynsection">
  41 <p><center><img src="classBarry_1_1ZeroPacket__coll__graph.png" border="0" usemap="#Barry_1_1ZeroPacket__coll__map" alt="Collaboration graph"></center>
  42 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
  43
  44 <p>
  45 <a href="classBarry_1_1ZeroPacket-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
  46 Provides an API for building and analyzing socket-0 protocol packets.
  47 <p>
  48 This class relies on 2 external objects: a send and receive Data buffer.<p>
  49 Note that the receive buffer may be modified during a packet send, and this class provides API helpers to analyze the results.
  50 <p>Definition at line <a class="el" href="packet_8h-source.html#l00087">87</a> of file <a class="el" href="packet_8h-source.html">packet.h</a>.</p>
  51 <table border="0" cellpadding="0" cellspacing="0">
  52 <tr><td></td></tr>
  53 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ZeroPacket.html#7737431baba17201d588f1dba4c8bbe0">GetAttribute</a> (unsigned int object, unsigned int attribute)</td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Builds a command packet for the initial socket-0 handshakes that fetch certain (some unknown) attributes.  <a href="#7737431baba17201d588f1dba4c8bbe0"></a><br></td></tr>
  57 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ZeroPacket.html#274fb9e330544f188df45f03ebe9180a">Echo</a> (uint64_t us_ticks)</td></tr>
  58
  59 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Builds command packet for sending echo request.  <a href="#274fb9e330544f188df45f03ebe9180a"></a><br></td></tr>
  60 </table>
  61 <hr><h2>Member Function Documentation</h2>
  62 <a class="anchor" name="7737431baba17201d588f1dba4c8bbe0"></a><!-- doxytag: member="Barry::ZeroPacket::GetAttribute" ref="7737431baba17201d588f1dba4c8bbe0" args="(unsigned int object, unsigned int attribute)" -->
  63 <div class="memitem">
  64 <div class="memproto">
  65       <table class="memname">
  66         <tr>
  67           <td class="memname">void Barry::ZeroPacket::GetAttribute           </td>
  68           <td>(</td>
  69           <td class="paramtype">unsigned int&nbsp;</td>
  70           <td class="paramname"> <em>object</em>, </td>
  71         </tr>
  72         <tr>
  73           <td class="paramkey"></td>
  74           <td></td>
  75           <td class="paramtype">unsigned int&nbsp;</td>
  76           <td class="paramname"> <em>attribute</em></td><td>&nbsp;</td>
  77         </tr>
  78         <tr>
  79           <td></td>
  80           <td>)</td>
  81           <td></td><td></td><td></td>
  82         </tr>
  83       </table>
  84 </div>
  85 <div class="memdoc">
  86
  87 <p>
  88 Builds a command packet for the initial socket-0 handshakes that fetch certain (some unknown) attributes.
  89 <p>
  90 The attributes appear to exist in an object/attribute sequence, so that's how we address them here.
  91 <p>Definition at line <a class="el" href="packet_8cc-source.html#l00078">78</a> of file <a class="el" href="packet_8cc-source.html">packet.cc</a>.</p>
  92
  93 </div>
  94 </div><p>
  95 <a class="anchor" name="274fb9e330544f188df45f03ebe9180a"></a><!-- doxytag: member="Barry::ZeroPacket::Echo" ref="274fb9e330544f188df45f03ebe9180a" args="(uint64_t us_ticks)" -->
  96 <div class="memitem">
  97 <div class="memproto">
  98       <table class="memname">
  99         <tr>
 100           <td class="memname">void Barry::ZeroPacket::Echo           </td>
 101           <td>(</td>
 102           <td class="paramtype">uint64_t&nbsp;</td>
 103           <td class="paramname"> <em>us_ticks</em>          </td>
 104           <td>&nbsp;)&nbsp;</td>
 105           <td></td>
 106         </tr>
 107       </table>
 108 </div>
 109 <div class="memdoc">
 110
 111 <p>
 112 Builds command packet for sending echo request.
 113 <p>
 114 The parameter to this command is the number of microseconds elapsed since host computer startup.
 115 <p>Definition at line <a class="el" href="packet_8cc-source.html#l00102">102</a> of file <a class="el" href="packet_8cc-source.html">packet.cc</a>.</p>
 116
 117 </div>
 118 </div><p>
 119 <hr>The documentation for this class was generated from the following files:<ul>
 120 <li><a class="el" href="packet_8h-source.html">packet.h</a><li><a class="el" href="packet_8cc-source.html">packet.cc</a></ul>
 121 </div>
 122 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:39 2011 for Barry by&nbsp;
 123 <a href="http://www.doxygen.org/index.html">
 124 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 125 </body>
 126 </html>