TAO_AV  2.1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
TAO_FlowConsumer Class Reference

#include <AVStreams_i.h>

Inheritance diagram for TAO_FlowConsumer:
Inheritance graph
[legend]
Collaboration diagram for TAO_FlowConsumer:
Collaboration graph
[legend]

Public Member Functions

 TAO_FlowConsumer (void)
 default constructor.
 TAO_FlowConsumer (const char *flowname, AVStreams::protocolSpec protocols, const char *format)
virtual void stop (void)
 stop this flow, to be overridden by the application.
virtual void start (void)
 start this flow, to be overridden by the application.
virtual char * go_to_listen (AVStreams::QoS &the_qos, CORBA::Boolean is_mcast, AVStreams::FlowEndPoint_ptr peer, char *&flowProtocol)
virtual CORBA::Boolean connect_to_peer (AVStreams::QoS &the_qos, const char *address, const char *use_flow_protocol)
- Public Member Functions inherited from TAO_FlowEndPoint
 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 (void)
 lock the flow endpoint for a particular flow.
virtual void unlock (void)
 unlock the flow endpoint for subsequent use.
virtual void destroy (void)
 destroy this flow.
virtual
AVStreams::StreamEndPoint_ptr 
related_sep (void)
virtual void related_sep (AVStreams::StreamEndPoint_ptr related_sep)
virtual
AVStreams::FlowConnection_ptr 
related_flow_connection (void)
virtual void related_flow_connection (AVStreams::FlowConnection_ptr related_flow_connection)
 set method for the related flow connection attribute.
virtual AVStreams::FlowEndPoint_ptr get_connected_fep (void)
 returns the other flowendpoint to which this is connected.
virtual CORBA::Boolean use_flow_protocol (const char *fp_name, const CORBA::Any &fp_settings)
virtual void set_format (const char *format)
 sets the data format.
virtual void set_dev_params (const CosPropertyService::Properties &new_settings)
 sets the device parameters.
virtual void set_protocol_restriction (const AVStreams::protocolSpec &the_spec)
 sets the list of protocols to be used.
virtual CORBA::Boolean is_fep_compatible (AVStreams::FlowEndPoint_ptr fep)
 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)
 sets the peer flowendpoint.
virtual CORBA::Boolean set_Mcast_peer (AVStreams::FlowConnection_ptr the_fc, AVStreams::MCastConfigIf_ptr a_mcastconfigif, AVStreams::QoS &the_qos)
 sets the multicast peer flowendpoint, not implemented.
virtual CORBA::Boolean connect_to_peer_i (TAO_FlowSpec_Entry::Role role, AVStreams::QoS &the_qos, const char *address, const char *use_flow_protocol)
 connect to the peer endpoint.
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)
 listen request from the peer.
- Public Member Functions inherited from TAO_Base_StreamEndPoint
 TAO_Base_StreamEndPoint (void)
virtual ~TAO_Base_StreamEndPoint (void)
virtual int handle_open (void)
 called when streamendpoint is instantiated
virtual int handle_close (void)
 called when streamendpoint is being destructed
virtual int handle_stop (const AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual int handle_start (const AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual int handle_destroy (const AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual CORBA::Boolean handle_preconnect (AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual CORBA::Boolean handle_postconnect (AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual CORBA::Boolean handle_connection_requested (AVStreams::flowSpec &the_spec)
 Application needs to define this.
virtual int get_callback (const char *flowname, TAO_AV_Callback *&callback)
virtual int get_control_callback (const char *flowname, TAO_AV_Callback *&callback)
virtual void set_control_flow_handler (const char *flowname, TAO_AV_Flow_Handler *handler)
TAO_AV_QoSqos (void)
void protocol_object_set (void)
int is_protocol_object_set (void)

Additional Inherited Members

- Protected Attributes inherited from TAO_FlowEndPoint
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_

Constructor & Destructor Documentation

TAO_FlowConsumer::TAO_FlowConsumer ( void  )

default constructor.

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

Member Function Documentation

CORBA::Boolean TAO_FlowConsumer::connect_to_peer ( AVStreams::QoS the_qos,
const char *  address,
const char *  use_flow_protocol 
)
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.

Implements TAO_FlowEndPoint.

char * TAO_FlowConsumer::go_to_listen ( AVStreams::QoS the_qos,
CORBA::Boolean  is_mcast,
AVStreams::FlowEndPoint_ptr  peer,
char *&  flowProtocol 
)
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.

Implements TAO_FlowEndPoint.

void TAO_FlowConsumer::start ( void  )
virtual

start this flow, to be overridden by the application.

void TAO_FlowConsumer::stop ( void  )
virtual

stop this flow, to be overridden by the application.


The documentation for this class was generated from the following files: