Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 2aa62c5bbb658df1fece777472a7bcf2 > files > 976

barry-devel-docs-0.17-0.3.20100730git.fc14.noarch.rpm

<!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::ZeroPacket 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1ZeroPacket.html">ZeroPacket</a>
  </div>
</div>
<div class="contents">
<h1>Barry::ZeroPacket Class Reference</h1><!-- doxytag: class="Barry::ZeroPacket" --><!-- doxytag: inherits="Barry::Packet" -->
<p>Provides an API for building and analyzing socket-0 protocol packets.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="packet_8h_source.html">packet.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Barry::ZeroPacket:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1ZeroPacket__inherit__graph.png" border="0" usemap="#Barry_1_1ZeroPacket_inherit__map" alt="Inheritance graph"/></div>
<map name="Barry_1_1ZeroPacket_inherit__map" id="Barry_1_1ZeroPacket_inherit__map">
<area shape="rect" id="node2" href="classBarry_1_1Packet.html" title="Barry::Packet" alt="" coords="20,6,121,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Barry::ZeroPacket:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1ZeroPacket__coll__graph.png" border="0" usemap="#Barry_1_1ZeroPacket_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1ZeroPacket_coll__map" id="Barry_1_1ZeroPacket_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Packet.html" title="Barry::Packet" alt="" coords="20,123,121,154"/><area shape="rect" id="node4" href="classBarry_1_1Data.html" title="Barry::Data" alt="" coords="25,6,116,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classBarry_1_1ZeroPacket-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ZeroPacket.html#a7737431baba17201d588f1dba4c8bbe0">GetAttribute</a> (unsigned int object, unsigned int attribute)</td></tr>
<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="#a7737431baba17201d588f1dba4c8bbe0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1ZeroPacket.html#a274fb9e330544f188df45f03ebe9180a">Echo</a> (uint64_t us_ticks)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Builds command packet for sending echo request.  <a href="#a274fb9e330544f188df45f03ebe9180a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides an API for building and analyzing socket-0 protocol packets. </p>
<p>This class relies on 2 external objects: a send and receive <a class="el" href="classBarry_1_1Data.html">Data</a> buffer.</p>
<p>Note that the receive buffer may be modified during a packet send, and this class provides API helpers to analyze the results. </p>

<p>Definition at line <a class="el" href="packet_8h_source.html#l00079">79</a> of file <a class="el" href="packet_8h_source.html">packet.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a274fb9e330544f188df45f03ebe9180a"></a><!-- doxytag: member="Barry::ZeroPacket::Echo" ref="a274fb9e330544f188df45f03ebe9180a" args="(uint64_t us_ticks)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Barry::ZeroPacket::Echo </td>
          <td>(</td>
          <td class="paramtype">uint64_t&nbsp;</td>
          <td class="paramname"> <em>us_ticks</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Builds command packet for sending echo request. </p>
<p>The parameter to this command is the number of microseconds elapsed since host computer startup. </p>

<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>

</div>
</div>
<a class="anchor" id="a7737431baba17201d588f1dba4c8bbe0"></a><!-- doxytag: member="Barry::ZeroPacket::GetAttribute" ref="a7737431baba17201d588f1dba4c8bbe0" args="(unsigned int object, unsigned int attribute)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Barry::ZeroPacket::GetAttribute </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>attribute</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Builds a command packet for the initial socket-0 handshakes that fetch certain (some unknown) attributes. </p>
<p>The attributes appear to exist in an object/attribute sequence, so that's how we address them here. </p>

<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>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="packet_8h_source.html">packet.h</a></li>
<li><a class="el" href="packet_8cc_source.html">packet.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<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>