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

TAO_FlowEndPoint Class Reference

This class is used per flow e.g video flow and an audio flow to encapsulate the transport details. More...

#include <AVStreams_i.h>

Inheritance diagram for TAO_FlowEndPoint:

Inheritance graph
[legend]
Collaboration diagram for TAO_FlowEndPoint:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TAO_FlowEndPoint (void)
 default constructor.

 TAO_FlowEndPoint (const char *flowname, AVStreams::protocolSpec &protocols, const char *format)
int open (const char *flowname, AVStreams::protocolSpec &protocols, const char *format)
int set_flowname (const char *flowname)
virtual void set_flow_handler (const char *flowname, TAO_AV_Flow_Handler *handler)
virtual int set_protocol_object (const char *flowname, TAO_AV_Protocol_Object *object)
virtual CORBA::Boolean lock (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 lock the flow endpoint for a particular flow.

virtual void unlock (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 unlock the flow endpoint for subsequent use.

virtual void destroy (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 destroy this flow.

virtual AVStreams::StreamEndPoint_ptr related_sep (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual void related_sep (AVStreams::StreamEndPoint_ptr related_sep ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual AVStreams::FlowConnection_ptr related_flow_connection (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
virtual void related_flow_connection (AVStreams::FlowConnection_ptr related_flow_connection ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException)
 set method for the related flow connection attribute.

virtual AVStreams::FlowEndPoint_ptr get_connected_fep (ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::notConnected, AVStreams::notSupported)
 returns the other flowendpoint to which this is connected.

virtual CORBA::Boolean use_flow_protocol (const char *fp_name, const CORBA::Any &fp_settings ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::FPError, AVStreams::notSupported)
virtual void set_format (const char *format ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::notSupported)
 sets the data format.

virtual void set_dev_params (const CosPropertyService::Properties &new_settings ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::PropertyException, AVStreams::streamOpFailed)
 sets the device parameters.

virtual void set_protocol_restriction (const AVStreams::protocolSpec &the_spec ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::notSupported)
 sets the list of protocols to be used.

virtual CORBA::Boolean is_fep_compatible (AVStreams::FlowEndPoint_ptr fep ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::formatMismatch, AVStreams::deviceQosMismatch)
 checks whether the passed flowendpoint is compatible with this.

virtual CORBA::Boolean set_peer (AVStreams::FlowConnection_ptr the_fc, AVStreams::FlowEndPoint_ptr the_peer_fep, AVStreams::QoS &the_qos ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::QoSRequestFailed, AVStreams::streamOpFailed)
 sets the peer flowendpoint.

virtual CORBA::Boolean set_Mcast_peer (AVStreams::FlowConnection_ptr the_fc, AVStreams::MCastConfigIf_ptr a_mcastconfigif, AVStreams::QoS &the_qos ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::QoSRequestFailed)
 sets the multicast peer flowendpoint, not implemented.

virtual CORBA::Boolean connect_to_peer (AVStreams::QoS &the_qos, const char *address, const char *use_flow_protocol ACE_ENV_ARG_DECL_WITH_DEFAULTS)=0 throw (CORBA::SystemException, AVStreams::failedToConnect, AVStreams::FPError, AVStreams::QoSRequestFailed)
virtual CORBA::Boolean connect_to_peer_i (TAO_FlowSpec_Entry::Role role, AVStreams::QoS &the_qos, const char *address, const char *use_flow_protocol ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::failedToConnect, AVStreams::FPError, AVStreams::QoSRequestFailed)
 connect to the peer endpoint.

virtual char * go_to_listen (AVStreams::QoS &the_qos, CORBA::Boolean is_mcast, AVStreams::FlowEndPoint_ptr peer, char *&flowProtocol ACE_ENV_ARG_DECL_WITH_DEFAULTS)=0 throw (CORBA::SystemException, AVStreams::failedToListen, AVStreams::FPError, AVStreams::QoSRequestFailed)
virtual char * go_to_listen_i (TAO_FlowSpec_Entry::Role role, AVStreams::QoS &the_qos, CORBA::Boolean is_mcast, AVStreams::FlowEndPoint_ptr peer, char *&flowProtocol ACE_ENV_ARG_DECL_WITH_DEFAULTS) throw (CORBA::SystemException, AVStreams::failedToListen, AVStreams::FPError, AVStreams::QoSRequestFailed)
 listen request from the peer.


Protected Attributes

AVStreams::StreamEndPoint_var related_sep_
 The related streamendpoint.

AVStreams::FlowConnection_var related_flow_connection_
 The related flow connection reference.

AVStreams::FlowEndPoint_var peer_fep_
 The peer flowendpoint reference.

AVStreams::protocolSpec protocols_
 Available protocols for this flowendpoint.

AVStreams::protocolSpec protocol_addresses_
 Address information for the protocols.

AVStreams::MCastConfigIf_var mcast_peer_
 The multicast peer endpoint.

CORBA::Boolean lock_
 Lock.

CORBA::String_var format_
CORBA::String_var flowname_
CosPropertyService::Properties dev_params_
TAO_AV_FlowSpecSet flow_spec_set_
CORBA::String_var reverse_channel_

Detailed Description

This class is used per flow e.g video flow and an audio flow to encapsulate the transport details.

Definition at line 1155 of file AVStreams_i.h.

Constructor & Destructor Documentation

TAO_FlowEndPoint::TAO_FlowEndPoint (  void   ) 
 

default constructor.

Definition at line 4424 of file AVStreams_i.cpp. 

04425   :lock_ (0)
04426 {
04427 }

TAO_FlowEndPoint::TAO_FlowEndPoint (  const char *  flowname,
AVStreams::protocolSpec &  protocols,
const char *  format
) 
 

Definition at line 4429 of file AVStreams_i.cpp.

References open(), and AVStreams::protocolSpec. 

04432 {
04433   this->open (flowname, protocols, format);
04434 }

Member Function Documentation

virtual CORBA::Boolean TAO_FlowEndPoint::connect_to_peer (  AVStreams::QoS &  the_qos,
const char *  address,
const char *use_flow_protocol  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::failedToConnect, AVStreams::FPError, AVStreams::QoSRequestFailed) [pure virtual]
 

This should be implemented in both the FlowProducer and consumer and hence is pure virtual since we need to know the role of the flowendpoint to create appropriate protocol objects. eg. in SFP to create Producer Object/ Consumer Object.

Implemented in TAO_FlowProducer, and TAO_FlowConsumer.

virtual CORBA::Boolean TAO_FlowEndPoint::connect_to_peer_i (  TAO_FlowSpec_Entry::Role  role,
AVStreams::QoS &  the_qos,
const char *  address,
const char *use_flow_protocol  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::failedToConnect, AVStreams::FPError, AVStreams::QoSRequestFailed) [virtual]
 

connect to the peer endpoint.

virtual void TAO_FlowEndPoint::destroy (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

destroy this flow.

virtual AVStreams::FlowEndPoint_ptr TAO_FlowEndPoint::get_connected_fep (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException, AVStreams::notConnected, AVStreams::notSupported) [virtual]
 

returns the other flowendpoint to which this is connected.

virtual char* TAO_FlowEndPoint::go_to_listen (  AVStreams::QoS &  the_qos,
CORBA::Boolean  is_mcast,
AVStreams::FlowEndPoint_ptr  peer,
char *&flowProtocol  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::failedToListen, AVStreams::FPError, AVStreams::QoSRequestFailed) [pure virtual]
 

This should be implemented in both the FlowProducer and consumer and hence is pure virtual since we need to know the role of the flowendpoint to create appropriate protocol objects. eg. in SFP to create Producer Object/ Consumer Object.

Implemented in TAO_FlowProducer, and TAO_FlowConsumer.

virtual char* TAO_FlowEndPoint::go_to_listen_i (  TAO_FlowSpec_Entry::Role  role,
AVStreams::QoS &  the_qos,
CORBA::Boolean  is_mcast,
AVStreams::FlowEndPoint_ptr  peer,
char *&flowProtocol  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::failedToListen, AVStreams::FPError, AVStreams::QoSRequestFailed) [virtual]
 

listen request from the peer.

virtual CORBA::Boolean TAO_FlowEndPoint::is_fep_compatible (  AVStreams::FlowEndPoint_ptr fep  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException, AVStreams::formatMismatch, AVStreams::deviceQosMismatch) [virtual]
 

checks whether the passed flowendpoint is compatible with this.

virtual CORBA::Boolean TAO_FlowEndPoint::lock (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

lock the flow endpoint for a particular flow.

int TAO_FlowEndPoint::open (  const char *  flowname,
AVStreams::protocolSpec &  protocols,
const char *  format
) 
 

Definition at line 4443 of file AVStreams_i.cpp.

References ACE_ANY_EXCEPTION, ACE_CATCHANY, ACE_CHECK_RETURN, ACE_DEBUG, ACE_DECLARE_NEW_CORBA_ENV, ACE_ENDTRY, ACE_ENV_ARG_PARAMETER, ACE_PRINT_EXCEPTION, ACE_TRY, ACE_TRY_CHECK, TAO_FlowSpec_Entry::carrier_protocol_str(), flowname_, format_, LM_DEBUG, protocol_addresses_, AVStreams::protocolSpec, set_format(), set_protocol_restriction(), CORBA::string_dup(), and TAO_debug_level.

Referenced by TAO_FlowConsumer::TAO_FlowConsumer(), TAO_FlowEndPoint(), and TAO_FlowProducer::TAO_FlowProducer(). 

04446 {
04447   this->flowname_ = flowname;
04448   this->format_ = format;
04449 
04450   if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, "TAO_FlowEndPoint::open\n"));
04451   ACE_DECLARE_NEW_CORBA_ENV;
04452   ACE_TRY
04453     {
04454       CORBA::Any flowname_any;
04455       flowname_any <<= flowname;
04456       this->define_property ("FlowName",
04457                              flowname_any
04458                              ACE_ENV_ARG_PARAMETER);
04459       ACE_TRY_CHECK;
04460       this->set_format (format
04461                         ACE_ENV_ARG_PARAMETER);
04462       ACE_TRY_CHECK;
04463       this->protocol_addresses_ = protocols;
04464       AVStreams::protocolSpec protocol_spec (protocols.length ());
04465       protocol_spec.length (protocols.length ());
04466       if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, "%N:%l\n"));
04467       for (u_int i=0;i<protocols.length ();i++)
04468         {
04469           CORBA::String_var address = CORBA::string_dup (protocols [i]);
04470           TAO_Forward_FlowSpec_Entry entry ("", "", "", "", address.in ());
04471           protocol_spec [i] = CORBA::string_dup (entry.carrier_protocol_str ());
04472           if (TAO_debug_level > 0)
04473             ACE_DEBUG ((LM_DEBUG,
04474                         "[%s]\n",
04475                         static_cast<char const*>(protocol_spec[i])));
04476         }
04477       this->set_protocol_restriction (protocol_spec
04478                                       ACE_ENV_ARG_PARAMETER);
04479       ACE_TRY_CHECK;
04480     }
04481   ACE_CATCHANY
04482     {
04483       ACE_PRINT_EXCEPTION (ACE_ANY_EXCEPTION, "TAO_FlowEndPoint::open");
04484       return -1;
04485     }
04486   ACE_ENDTRY;
04487   ACE_CHECK_RETURN (-1);
04488   return 0;
04489 }

void TAO_FlowEndPoint::related_flow_connection (  AVStreams::FlowConnection_ptr related_flow_connection  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

set method for the related flow connection attribute.

Definition at line 4559 of file AVStreams_i.cpp. 

04562 {
04563   this->related_flow_connection_ = AVStreams::FlowConnection::_duplicate (related_flow_connection);
04564 }

virtual AVStreams::FlowConnection_ptr TAO_FlowEndPoint::related_flow_connection (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

void TAO_FlowEndPoint::related_sep (  AVStreams::StreamEndPoint_ptr related_sep  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException) [virtual]
 

set method for the related streamendpoint under which this flowendpoint is.

Definition at line 4544 of file AVStreams_i.cpp. 

04547 {
04548   this->related_sep_ = AVStreams::StreamEndPoint::_duplicate (related_sep);
04549 }

virtual AVStreams::StreamEndPoint_ptr TAO_FlowEndPoint::related_sep (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

get method for the related streamendpoint under which this flowendpoint is.

virtual void TAO_FlowEndPoint::set_dev_params (  const CosPropertyService::Properties &new_settings  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException, AVStreams::PropertyException, AVStreams::streamOpFailed) [virtual]
 

sets the device parameters.

void TAO_FlowEndPoint::set_flow_handler (  const char *  flowname,
TAO_AV_Flow_Handler *  handler
)  [virtual]
 

Reimplemented from TAO_Base_StreamEndPoint.

Definition at line 4437 of file AVStreams_i.cpp. 

04439 {
04440 }

int TAO_FlowEndPoint::set_flowname (  const char *  flowname  ) 
 

Definition at line 4493 of file AVStreams_i.cpp.

References flowname_. 

04494 {
04495   this->flowname_ = flowname;
04496   return 0;
04497 }

virtual void TAO_FlowEndPoint::set_format (  const char *format  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException, AVStreams::notSupported) [virtual]
 

sets the data format.

Referenced by open().

virtual CORBA::Boolean TAO_FlowEndPoint::set_Mcast_peer (  AVStreams::FlowConnection_ptr  the_fc,
AVStreams::MCastConfigIf_ptr  a_mcastconfigif,
AVStreams::QoS &the_qos  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::QoSRequestFailed) [virtual]
 

sets the multicast peer flowendpoint, not implemented.

virtual CORBA::Boolean TAO_FlowEndPoint::set_peer (  AVStreams::FlowConnection_ptr  the_fc,
AVStreams::FlowEndPoint_ptr  the_peer_fep,
AVStreams::QoS &the_qos  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::QoSRequestFailed, AVStreams::streamOpFailed) [virtual]
 

sets the peer flowendpoint.

int TAO_FlowEndPoint::set_protocol_object (  const char *  flowname,
TAO_AV_Protocol_Object *  object
)  [virtual]
 

Reimplemented from TAO_Base_StreamEndPoint.

Definition at line 4953 of file AVStreams_i.cpp. 

04955 {
04956   return 0;
04957 }

virtual void TAO_FlowEndPoint::set_protocol_restriction (  const AVStreams::protocolSpec &the_spec  ACE_ENV_ARG_DECL_WITH_DEFAULTS  )  throw (CORBA::SystemException, AVStreams::notSupported) [virtual]
 

sets the list of protocols to be used.

Referenced by open().

virtual void TAO_FlowEndPoint::unlock (  ACE_ENV_SINGLE_ARG_DECL_WITH_DEFAULTS   )  throw (CORBA::SystemException) [virtual]
 

unlock the flow endpoint for subsequent use.

virtual CORBA::Boolean TAO_FlowEndPoint::use_flow_protocol (  const char *  fp_name,
const CORBA::Any &fp_settings  ACE_ENV_ARG_DECL_WITH_DEFAULTS
)  throw (CORBA::SystemException, AVStreams::FPError, AVStreams::notSupported) [virtual]
 

Member Data Documentation

CosPropertyService::Properties TAO_FlowEndPoint::dev_params_ [protected]
 

Definition at line 1350 of file AVStreams_i.h.

TAO_AV_FlowSpecSet TAO_FlowEndPoint::flow_spec_set_ [protected]
 

Definition at line 1351 of file AVStreams_i.h.

CORBA::String_var TAO_FlowEndPoint::flowname_ [protected]
 

Definition at line 1349 of file AVStreams_i.h.

Referenced by open(), and set_flowname().

CORBA::String_var TAO_FlowEndPoint::format_ [protected]
 

Definition at line 1348 of file AVStreams_i.h.

Referenced by open().

CORBA::Boolean TAO_FlowEndPoint::lock_ [protected]
 

Lock.

Definition at line 1346 of file AVStreams_i.h.

AVStreams::MCastConfigIf_var TAO_FlowEndPoint::mcast_peer_ [protected]
 

The multicast peer endpoint.

Definition at line 1343 of file AVStreams_i.h.

AVStreams::FlowEndPoint_var TAO_FlowEndPoint::peer_fep_ [protected]
 

The peer flowendpoint reference.

Definition at line 1334 of file AVStreams_i.h.

AVStreams::protocolSpec TAO_FlowEndPoint::protocol_addresses_ [protected]
 

Address information for the protocols.

Definition at line 1340 of file AVStreams_i.h.

Referenced by open().

AVStreams::protocolSpec TAO_FlowEndPoint::protocols_ [protected]
 

Available protocols for this flowendpoint.

Definition at line 1337 of file AVStreams_i.h.

AVStreams::FlowConnection_var TAO_FlowEndPoint::related_flow_connection_ [protected]
 

The related flow connection reference.

Definition at line 1331 of file AVStreams_i.h.

AVStreams::StreamEndPoint_var TAO_FlowEndPoint::related_sep_ [protected]
 

The related streamendpoint.

Definition at line 1328 of file AVStreams_i.h.

CORBA::String_var TAO_FlowEndPoint::reverse_channel_ [protected]
 

Definition at line 1352 of file AVStreams_i.h.

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