RTCP_Channel_Out Class Reference

The RTCP_Channel_Out class represents a single outgoing data channel, or stream. It keeps track of statistics such as number of packets sent and number of bytes sent. More...

#include <RTCP_Channel.h>

Collaboration diagram for RTCP_Channel_Out:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 RTCP_Channel_Out (void)
 Constructor.
 ~RTCP_Channel_Out (void)
 Destructor.
void updateStatistics (RTP_Packet *pkt)
 Update the channel statistics each time an RTP packet is sent.
ACE_UINT32 timestamp (void)
 Returns the timestamp of the last RTP packet sent.
ACE_UINT32 packets_sent (void)
 Returns the number of packets sent.
ACE_UINT32 octets_sent (void)
 Returns the number of octets sent.
void cname (const char *cname)
 Sets the canonical name of the source.
const char * cname (void)
 Returns the canonical name of the source.
char active (void)
 Returns whether or not this source is active.

Private Attributes

ACE_CString cname_
 Holds the canonical name for this channel.
char active_
 Flag to indicate whether or not this channel is active.
unsigned int seq_num_
 The sequence number of the last RTP packet sent.
unsigned int timestamp_
 The timestamp of the last RTP packet sent.
unsigned int timestamp_offset_
 The initial offset of the timestamp.
unsigned int packets_sent_
 The total number of packets sent.
unsigned int octets_sent_
 The total numbef of octets sent.

Detailed Description

The RTCP_Channel_Out class represents a single outgoing data channel, or stream. It keeps track of statistics such as number of packets sent and number of bytes sent.

Definition at line 167 of file RTCP_Channel.h.


Constructor & Destructor Documentation

RTCP_Channel_Out::RTCP_Channel_Out ( void   ) 

Constructor.

Definition at line 313 of file RTCP_Channel.cpp.

00314   :cname_ ("cname"),
00315    active_ (0),
00316    timestamp_ (0),
00317    timestamp_offset_ (0),
00318    packets_sent_ (0),
00319    octets_sent_ (0)
00320 {
00321 }

RTCP_Channel_Out::~RTCP_Channel_Out ( void   ) 

Destructor.

Definition at line 323 of file RTCP_Channel.cpp.

00324 {
00325 }


Member Function Documentation

char RTCP_Channel_Out::active ( void   ) 

Returns whether or not this source is active.

Definition at line 359 of file RTCP_Channel.cpp.

References active_.

00360 {
00361   return this->active_;
00362 }

const char* RTCP_Channel_Out::cname ( void   )  [inline]

Returns the canonical name of the source.

Definition at line 192 of file RTCP_Channel.h.

References ACE_String_Base< CHAR >::c_str(), and cname_.

00192 { return this->cname_.c_str(); }

void RTCP_Channel_Out::cname ( const char *  cname  )  [inline]

Sets the canonical name of the source.

Definition at line 189 of file RTCP_Channel.h.

References cname_.

Referenced by TAO_AV_RTCP_Callback::send_report(), and TAO_AV_RTCP_Callback::TAO_AV_RTCP_Callback().

00189 { this->cname_ = cname; }

ACE_UINT32 RTCP_Channel_Out::octets_sent ( void   ) 

Returns the number of octets sent.

Definition at line 353 of file RTCP_Channel.cpp.

References octets_sent_.

Referenced by TAO_AV_RTCP_Callback::send_report().

00354 {
00355   return this->octets_sent_;
00356 }

ACE_UINT32 RTCP_Channel_Out::packets_sent ( void   ) 

Returns the number of packets sent.

Definition at line 347 of file RTCP_Channel.cpp.

References packets_sent_.

00348 {
00349   return this->packets_sent_;
00350 }

ACE_UINT32 RTCP_Channel_Out::timestamp ( void   ) 

Returns the timestamp of the last RTP packet sent.

Definition at line 341 of file RTCP_Channel.cpp.

References timestamp_.

00342 {
00343   return this->timestamp_;
00344 }

void RTCP_Channel_Out::updateStatistics ( RTP_Packet pkt  ) 

Update the channel statistics each time an RTP packet is sent.

Definition at line 328 of file RTCP_Channel.cpp.

References active_, octets_sent_, packets_sent_, RTP_Packet::payload_size(), seq_num_, RTP_Packet::sn(), timestamp_, and RTP_Packet::ts().

Referenced by TAO_AV_RTCP_Callback::send_frame().

00329 {
00330   // indicate that this source is active
00331   this->active_ = 1;
00332 
00333   // Update various counters.
00334   this->octets_sent_ += data_packet->payload_size();
00335   this->packets_sent_ ++;
00336   this->seq_num_ = data_packet->sn ();
00337   this->timestamp_ = data_packet->ts ();
00338 }


Member Data Documentation

char RTCP_Channel_Out::active_ [private]

Flag to indicate whether or not this channel is active.

Definition at line 202 of file RTCP_Channel.h.

Referenced by active(), and updateStatistics().

ACE_CString RTCP_Channel_Out::cname_ [private]

Holds the canonical name for this channel.

Definition at line 199 of file RTCP_Channel.h.

Referenced by cname().

unsigned int RTCP_Channel_Out::octets_sent_ [private]

The total numbef of octets sent.

Definition at line 217 of file RTCP_Channel.h.

Referenced by octets_sent(), and updateStatistics().

unsigned int RTCP_Channel_Out::packets_sent_ [private]

The total number of packets sent.

Definition at line 214 of file RTCP_Channel.h.

Referenced by packets_sent(), and updateStatistics().

unsigned int RTCP_Channel_Out::seq_num_ [private]

The sequence number of the last RTP packet sent.

Definition at line 205 of file RTCP_Channel.h.

Referenced by updateStatistics().

unsigned int RTCP_Channel_Out::timestamp_ [private]

The timestamp of the last RTP packet sent.

Definition at line 208 of file RTCP_Channel.h.

Referenced by timestamp(), and updateStatistics().

unsigned int RTCP_Channel_Out::timestamp_offset_ [private]

The initial offset of the timestamp.

Definition at line 211 of file RTCP_Channel.h.


The documentation for this class was generated from the following files:
Generated on Tue Feb 2 17:47:58 2010 for TAO_AV by  doxygen 1.4.7