CrystalSpace

Public API Reference

Public Member Functions | Friends
csEventTree::SubscriberIterator Class Reference

The SubscriberIterator is a wrapper for the messy internals of figuring out which event handler to call next. More...

#include <csutil/cssubscription.h>

List of all members.

Public Member Functions

bool HasNext ()
 Test if there is another available handler.
iEventHandlerNext ()
 Return an available handler and mark it as "done".
 SubscriberIterator (iEventHandlerRegistry *r, csEventTree *t, csEventID bevent)
 Constructor.
 ~SubscriberIterator ()
 Destructor.

Friends

class csEventTree

Detailed Description

The SubscriberIterator is a wrapper for the messy internals of figuring out which event handler to call next.

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

Only one iterator may exist for a given event node at a time.

Definition at line 251 of file cssubscription.h.


Constructor & Destructor Documentation

Constructor.

Establishes the csEventTree reference to this iterator to ensure there can be only one.

Definition at line 258 of file cssubscription.h.

Destructor.

Remove the csEventTree reference to us.

Definition at line 275 of file cssubscription.h.


Member Function Documentation

Test if there is another available handler.

Definition at line 284 of file cssubscription.h.

Return an available handler and mark it as "done".

Definition at line 314 of file cssubscription.h.


The documentation for this class was generated from the following file:

Generated for Crystal Space 2.0 by doxygen 1.7.6.1