Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Search for 

TAO_AV_Callback Class Reference

Callback class that the user will be implementing for receiving frames from the network and also for timer events. More...

#include <Policy.h>

Inheritance diagram for TAO_AV_Callback:

Inheritance graph
[legend]
Collaboration diagram for TAO_AV_Callback:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TAO_AV_Callback (void)
virtual ~TAO_AV_Callback (void)
int open (TAO_AV_Protocol_Object *object, TAO_AV_Flow_Handler *handler)
 Called for opening the callback.

virtual int handle_start (void)
 Called during Streamctrl->start.

virtual int handle_stop (void)
 Called during Streamctrl->stop.

virtual int handle_timeout (void *arg)
 Called during timeout for Flow Producers.

virtual int schedule_timer (void)
virtual int receive_frame (ACE_Message_Block *frame, TAO_AV_frame_info *frame_info=0, const ACE_Addr &address=ACE_Addr::sap_any)
virtual int receive_control_frame (ACE_Message_Block *frame, const ACE_Addr &address=ACE_Addr::sap_any)
 address from which the frame was received.

virtual int handle_destroy (void)
 Called during Streamctrl->destroy i.e tear_down of the stream.

virtual void get_timeout (ACE_Time_Value *&tv, void *&arg)
TAO_AV_Protocol_Object * protocol_object (void)
 Accessor to protocol object.

virtual TAO_AV_PolicyList get_policies (void)
 get the policies for the protocol object.


Protected Attributes

TAO_AV_Protocol_Object * protocol_object_
TAO_AV_Flow_Handler * handler_

Detailed Description

Callback class that the user will be implementing for receiving frames from the network and also for timer events.

Definition at line 116 of file Policy.h.

Constructor & Destructor Documentation

TAO_AV_Callback::TAO_AV_Callback (  void   ) 
 

Definition at line 42 of file Policy.cpp. 

00043    :protocol_object_ (0)
00044 {
00045 }

TAO_AV_Callback::~TAO_AV_Callback (  void   )  [virtual]
 

Definition at line 47 of file Policy.cpp. 

00048 {
00049 }

Member Function Documentation

TAO_AV_PolicyList TAO_AV_Callback::get_policies (  void   )  [virtual]
 

get the policies for the protocol object.

Definition at line 114 of file Policy.cpp.

References TAO_AV_PolicyList.

Referenced by TAO_SFP_Consumer_Object::TAO_SFP_Consumer_Object(). 

00115 {
00116   TAO_AV_PolicyList list;
00117   return list;
00118 }

void TAO_AV_Callback::get_timeout (  ACE_Time_Value *&  tv,
void *&  arg
)  [virtual]
 

Called to get the timeout. If tv is 0 then the framework stop calling this. This will be called during the start of the frame and also if schedule_timer is called to get the timeout.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 99 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_Flow_Handler::handle_timeout(), and TAO_AV_Flow_Handler::schedule_timer(). 

00101 {
00102   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::get_timeout\n"));
00103   tv = 0;
00104 }

int TAO_AV_Callback::handle_destroy (  void   )  [virtual]
 

Called during Streamctrl->destroy i.e tear_down of the stream.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 92 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_UDP_Object::destroy(), TAO_AV_TCP_Object::destroy(), TAO_SFP_Object::destroy(), TAO_AV_RTP_Object::destroy(), TAO_AV_RTCP_Object::destroy(), and TAO_SFP_Consumer_Object::handle_input(). 

00093 {
00094   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::handle_end_stream\n"));
00095   return -1;
00096 }

int TAO_AV_Callback::handle_start (  void   )  [virtual]
 

Called during Streamctrl->start.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 62 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_Flow_Handler::start(), TAO_AV_RTP_Object::start(), TAO_AV_RTCP_Object::start(), and TAO_AV_Protocol_Object::start(). 

00063 {
00064   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::handle_start\n"));
00065   return -1;
00066 }

int TAO_AV_Callback::handle_stop (  void   )  [virtual]
 

Called during Streamctrl->stop.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 69 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_Flow_Handler::stop(), TAO_AV_RTP_Object::stop(), TAO_AV_RTCP_Object::stop(), and TAO_AV_Protocol_Object::stop(). 

00070 {
00071   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::handle_stop\n"));
00072   return -1;
00073 }

int TAO_AV_Callback::handle_timeout (  void *  arg  )  [virtual]
 

Called during timeout for Flow Producers.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 107 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_Flow_Handler::handle_timeout(). 

00108 {
00109   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::handle_timeout\n"));
00110   return 0;
00111 }

int TAO_AV_Callback::open (  TAO_AV_Protocol_Object *  object,
TAO_AV_Flow_Handler *  handler
) 
 

Called for opening the callback.

Definition at line 52 of file Policy.cpp.

References TAO_AV_Flow_Handler::callback().

Referenced by TAO_AV_SFP_Factory::make_protocol_object(), and TAO_AV_RTCP_Flow_Factory::make_protocol_object(). 

00054 {
00055   this->protocol_object_ = object;
00056   this->handler_ = handler;
00057   handler->callback (this);
00058   return 0;
00059 }

TAO_AV_Protocol_Object * TAO_AV_Callback::protocol_object (  void   ) 
 

Accessor to protocol object.

Definition at line 133 of file Policy.cpp. 

00134 {
00135   return this->protocol_object_;
00136 }

int TAO_AV_Callback::receive_control_frame (  ACE_Message_Block *  frame,
const ACE_Addr &  address = ACE_Addr::sap_any
)  [virtual]
 

address from which the frame was received.

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 85 of file Policy.cpp.

Referenced by TAO_AV_RTCP_Object::handle_input(). 

00087 {
00088   return 0;
00089 }

int TAO_AV_Callback::receive_frame (  ACE_Message_Block *  frame,
TAO_AV_frame_info *  frame_info = 0,
const ACE_Addr &  address = ACE_Addr::sap_any
)  [virtual]
 

Reimplemented in TAO_AV_RTCP_Callback.

Definition at line 76 of file Policy.cpp.

References ACE_DEBUG, LM_DEBUG, and TAO_debug_level.

Referenced by TAO_AV_RTCP_Object::handle_control_input(), TAO_AV_UDP_Object::handle_input(), TAO_AV_TCP_Object::handle_input(), TAO_SFP_Consumer_Object::handle_input(), and TAO_AV_RTP_Object::handle_input(). 

00079 {
00080   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG,"TAO_AV_Callback::receive_frame\n"));
00081   return -1;
00082 }

int TAO_AV_Callback::schedule_timer (  void   )  [virtual]
 

Definition at line 145 of file Policy.cpp.

References TAO_AV_Flow_Handler::schedule_timer(). 

00146 {
00147   return this->handler_->schedule_timer ();
00148 }

Member Data Documentation

TAO_AV_Flow_Handler* TAO_AV_Callback::handler_ [protected]
 

Definition at line 165 of file Policy.h.

TAO_AV_Protocol_Object* TAO_AV_Callback::protocol_object_ [protected]
 

Definition at line 164 of file Policy.h.

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 13:46:51 2006 for TAO_AV by doxygen 1.3.6