<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csEventTree::SubscriberIterator Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<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="pages.html"><span>Related Pages</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="nav">
<a class="el" href="classcsEventTree.html">csEventTree</a>::<a class="el" href="classcsEventTree_1_1SubscriberIterator.html">SubscriberIterator</a></div>
<h1>csEventTree::SubscriberIterator Class Reference</h1><!-- doxytag: class="csEventTree::SubscriberIterator" -->The <a class="el" href="classcsEventTree_1_1SubscriberIterator.html" title="The SubscriberIterator is a wrapper for the messy internals of figuring out which...">SubscriberIterator</a> is a wrapper for the messy internals of figuring out which event handler to call next.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cssubscription_8h-source.html">csutil/cssubscription.h</a>></code>
<p>
<p>
<a href="classcsEventTree_1_1SubscriberIterator-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">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#933e8e3585e7fc7e58d9c99307a09d4a">HasNext</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if there is another available handler. <a href="#933e8e3585e7fc7e58d9c99307a09d4a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#8b1cf47c6bc5ba7f071b527d79cd0c3a">Next</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an available handler and mark it as "done". <a href="#8b1cf47c6bc5ba7f071b527d79cd0c3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#67a979eb741e7db6ee1528e5b05d6bc8">SubscriberIterator</a> (<a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> *r, <a class="el" href="classcsEventTree.html">csEventTree</a> *t, <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> bevent)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#67a979eb741e7db6ee1528e5b05d6bc8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#db68e7387db5d2404a16a1a46b591fea">~SubscriberIterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#db68e7387db5d2404a16a1a46b591fea"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f404f613d3150d4f80c6da84fa375a24"></a><!-- doxytag: member="csEventTree::SubscriberIterator::csEventQueueTest" ref="f404f613d3150d4f80c6da84fa375a24" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#f404f613d3150d4f80c6da84fa375a24">csEventQueueTest</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38be8f61f3116fd02fd4b301a7d7ce9c"></a><!-- doxytag: member="csEventTree::SubscriberIterator::csEventTree" ref="38be8f61f3116fd02fd4b301a7d7ce9c" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventTree_1_1SubscriberIterator.html#38be8f61f3116fd02fd4b301a7d7ce9c">csEventTree</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classcsEventTree_1_1SubscriberIterator.html" title="The SubscriberIterator is a wrapper for the messy internals of figuring out which...">SubscriberIterator</a> is a wrapper for the messy internals of figuring out which event handler to call next.
<p>
In the common case, this is simply iterating over a pre-existing list (csEventTree::SubscriberQueue). There are degenerative cases where it must fall back on progressively solving the partial order graph (csEventTree::SubscriberGraph).<p>
Only one iterator may exist for a given event node at a time.
<p>Definition at line <a class="el" href="cssubscription_8h-source.html#l00251">251</a> of file <a class="el" href="cssubscription_8h-source.html">cssubscription.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="67a979eb741e7db6ee1528e5b05d6bc8"></a><!-- doxytag: member="csEventTree::SubscriberIterator::SubscriberIterator" ref="67a979eb741e7db6ee1528e5b05d6bc8" args="(iEventHandlerRegistry *r, csEventTree *t, csEventID bevent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEventTree::SubscriberIterator::SubscriberIterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandlerRegistry.html">iEventHandlerRegistry</a> * </td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsEventTree.html">csEventTree</a> * </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>bevent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Establishes the <a class="el" href="classcsEventTree.html" title="This class is used to represent the event namespace (tree).">csEventTree</a> reference to this iterator to ensure there can be only one.
<p>Definition at line <a class="el" href="cssubscription_8h-source.html#l00258">258</a> of file <a class="el" href="cssubscription_8h-source.html">cssubscription.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, <a class="el" href="cssubscription_8h-source.html#l00216">csEventTree::fatRecord</a>, and <a class="el" href="list_8h-source.html#l00263">csList< T >::Iterator</a>.</p>
</div>
</div><p>
<a class="anchor" name="db68e7387db5d2404a16a1a46b591fea"></a><!-- doxytag: member="csEventTree::SubscriberIterator::~SubscriberIterator" ref="db68e7387db5d2404a16a1a46b591fea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEventTree::SubscriberIterator::~SubscriberIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
Remove the <a class="el" href="classcsEventTree.html" title="This class is used to represent the event namespace (tree).">csEventTree</a> reference to us.
<p>Definition at line <a class="el" href="cssubscription_8h-source.html#l00275">275</a> of file <a class="el" href="cssubscription_8h-source.html">cssubscription.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="933e8e3585e7fc7e58d9c99307a09d4a"></a><!-- doxytag: member="csEventTree::SubscriberIterator::HasNext" ref="933e8e3585e7fc7e58d9c99307a09d4a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool csEventTree::SubscriberIterator::HasNext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if there is another available handler.
<p>
<p>Definition at line <a class="el" href="cssubscription_8h-source.html#l00284">284</a> of file <a class="el" href="cssubscription_8h-source.html">cssubscription.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="iutil_2eventhandlers_8h-source.html#l00033">CS_HANDLER_INVALID</a>.</p>
</div>
</div><p>
<a class="anchor" name="8b1cf47c6bc5ba7f071b527d79cd0c3a"></a><!-- doxytag: member="csEventTree::SubscriberIterator::Next" ref="8b1cf47c6bc5ba7f071b527d79cd0c3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structiEventHandler.html">iEventHandler</a>* csEventTree::SubscriberIterator::Next </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an available handler and mark it as "done".
<p>
<p>Definition at line <a class="el" href="cssubscription_8h-source.html#l00314">314</a> of file <a class="el" href="cssubscription_8h-source.html">cssubscription.h</a>.</p>
<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, and <a class="el" href="iutil_2eventhandlers_8h-source.html#l00033">CS_HANDLER_INVALID</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cssubscription_8h-source.html">cssubscription.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
493
