Main Page | Modules | Class Hierarchy | Class List | Directories | Class Members | Related Pages | Examples

FilteredStreamListener Class Reference

Class to deal with stream events. More...

#include <StreamListener.h>

Inheritance diagram for FilteredStreamListener:

StreamListener List of all members.

Public Member Functions

 FilteredStreamListener (void)
 default constructor
 FilteredStreamListener (const StreamEvent &f)
 construct a filtered stream listener
 FilteredStreamListener (const FilteredStreamListener &toCopy)
FilteredStreamListeneroperator= (const FilteredStreamListener &rhs)
virtual uint32_t handleStreamEvent (const StreamEvent &event)
 method to handle events
virtual uint32_t handlePassedStreamEvent (const StreamEvent &event)=0

Detailed Description

Class to deal with stream events.

Constructor & Destructor Documentation

FilteredStreamListener::FilteredStreamListener void   ) 

default constructor

By default, a StreamListener listens for all types of events

Member Function Documentation

uint32_t FilteredStreamListener::handleStreamEvent const StreamEvent event  )  [virtual]

method to handle events

code indicating what should be done with the stream: StreamEvent::STREAM_OK - no change to status StreamEvent::STREAM_ACTIVE - keep the stream active StreamEvent::STREAM_EXPIRE - expire the stream StreamEvent::STREAM_ERASE - delete the stream StreamEvent::STREAM_ERROR - complain and delete the stream
any change in status will generate a new event, so if a handler handles a stream expiry event and returns STREAM_EXPIRE, no new event will be generated. However, if it handles a stream active event and returns a STREAM_EXPIRE, the stream will be expired and a new stream expiry event will be generated. Note that this means we'll have to worry about loops.

Implements StreamListener.

The documentation for this class was generated from the following files:
Generated on Thu Apr 5 01:02:37 2007 for ANTARES by  doxygen 1.4.2