Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

SH::Report Class Reference

#include <SHReport.h>

Inheritance diagram for SH::Report:

Inheritance graph
[legend]
List of all members.

Public Types

typedef const char *const ID

Public Member Functions

 Report ()
virtual ~Report ()
void ref ()
void unref ()
virtual bool isA (ID id) const
virtual void dump (ostream &ostr) const

Static Public Attributes

ID Id

Friends

ostream & operator<< (ostream &ostr, const Report &report)

Detailed Description

Reports are asynchrounous messages that are travelling either upstream or downstream. There may be stream handlers in a flow that are specialized for processing of these report only. For data items, such stream handler may only be capable of through mode. One application of SHReports is in an RTP proxy; sender and receiver RTCP reports are not sent on the data path but travel alongside the data stream.


Member Typedef Documentation

typedef const char* const SH::Report::ID
 

Use this type to distinguish objects of this class from its siblings.


Constructor & Destructor Documentation

SH::Report::Report  ) 
 

virtual SH::Report::~Report  )  [virtual]
 


Member Function Documentation

virtual void SH::Report::dump ostream &  ostr  )  const [virtual]
 

This function is called by the operator<< and must be overloaded by all child classes.

Reimplemented in MNRTCPPacket, MNRTCPPacket_SR, MNRTCPPacket_RR, MNRTCPPacket_APP, and MNRTCPPacket_SDES.

virtual bool SH::Report::isA ID  id  )  const [virtual]
 

Find out whether an object that is of class Report or one of its childs classes is of the given type ID or not. The inheritance tree is traversed, so the test for Report::Id should always yield true.

void SH::Report::ref  ) 
 

void SH::Report::unref  ) 
 


Friends And Related Function Documentation

ostream& operator<< ostream &  ostr,
const Report report
[friend]
 


Member Data Documentation

ID SH::Report::Id [static]
 

Store the name of this class in this variable. Use this variable as a parameter to the function isA, to find out whether a report is of a certain type of not.

Note:
The comparison is an equality comparison, not a string comparison. You can not replace the parameter with an arbitrary one.

Reimplemented in MNRTCPPacket, MNRTCPPacket_SR, MNRTCPPacket_RR, MNRTCPPacket_APP, and MNRTCPPacket_SDES.


The documentation for this class was generated from the following file:
Generated on Sun Mar 6 13:36:36 2005 for Komssys by doxygen 1.3.8