Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > c200d180bc1063a7706e0da42a546b51 > files > 139

atlascpp-devel-0.6.1-7.fc12.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Atlas-C++: Atlas::Message::QueuedDecoder 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.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</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>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</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="namespace_atlas.html">Atlas</a>::<b>Message</b>::<a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html">QueuedDecoder</a>
  </div>
</div>
<div class="contents">
<h1>Atlas::Message::QueuedDecoder Class Reference</h1><!-- doxytag: class="Atlas::Message::QueuedDecoder" --><!-- doxytag: inherits="Atlas::Message::DecoderBase" -->Decoder that presents a queue of <a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Atlas::Message::Element</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="_queued_decoder_8h_source.html">QueuedDecoder.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for Atlas::Message::QueuedDecoder:</div>
<div class="dynsection">

<p><center><img src="class_atlas_1_1_message_1_1_queued_decoder.png" usemap="#Atlas::Message::QueuedDecoder_map" border="0" alt=""></center>
<map name="Atlas::Message::QueuedDecoder_map">
<area href="class_atlas_1_1_message_1_1_decoder_base.html" alt="Atlas::Message::DecoderBase" shape="rect" coords="0,56,197,80">
<area href="class_atlas_1_1_bridge.html" alt="Atlas::Bridge" shape="rect" coords="0,0,197,24">
</map>
</div>

<p>
<a href="class_atlas_1_1_message_1_1_queued_decoder-members.html">List of all members.</a><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"><a class="anchor" name="a186b748c8354f352f0a4f2e5e183730"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::queueSize" ref="a186b748c8354f352f0a4f2e5e183730" args="()" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#a186b748c8354f352f0a4f2e5e183730">queueSize</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the current size of the message queue. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69a25e892d37ac2b1d54df5897fc73c5"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::popMessage" ref="69a25e892d37ac2b1d54df5897fc73c5" args="()" -->
const MapType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#69a25e892d37ac2b1d54df5897fc73c5">popMessage</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pop an object from the front of the message queue. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ea51b410b4c70cccbcc3485a4050889"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::frontMessage" ref="4ea51b410b4c70cccbcc3485a4050889" args="()" -->
const MapType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#4ea51b410b4c70cccbcc3485a4050889">frontMessage</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Peek at the object at the front of the queue. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b6f0f82ddb6aaa8cd3e18e709f8a8e48"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::clearQueue" ref="b6f0f82ddb6aaa8cd3e18e709f8a8e48" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#b6f0f82ddb6aaa8cd3e18e709f8a8e48">clearQueue</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clear the message queue. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bac6b4693dfd60303a870fdf4aab2430"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::messageArrived" ref="bac6b4693dfd60303a870fdf4aab2430" args="(const MapType &amp;obj)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#bac6b4693dfd60303a870fdf4aab2430">messageArrived</a> (const MapType &amp;obj)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This adds a message to the queue. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Decoder that presents a queue of <a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Atlas::Message::Element</a>. 
<p>
This message decoder puts arrived objects into a queue and allows the application to pop them off the front of the queue, peek at the front of the queue, as well as checking to see how many objects are currently in the queue.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html" title="Base class for decoders that take Atlas::Message::Object.">DecoderBase</a> <p>
<a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Element</a> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Stefanus Du Toit &lt;<a href="mailto:sdt@gmx.net">sdt@gmx.net</a>&gt; </dd></dl>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_queued_decoder_8h_source.html">QueuedDecoder.h</a></ul>
</div>
<HR>
<P>Copyright 2000-2004 the respective authors.</P>
<P>This document can be licensed under the terms of the GNU Free Documentation
License or the GNU General Public License and may be freely distributed under
the terms given by one of these licenses.</P>