Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

TAO_FlowSpec_Entry Class Reference

A helper entry class in the flow spec sequence passed to bind_devs. More...

#include <FlowSpec_Entry.h>

Inheritance diagram for TAO_FlowSpec_Entry:

Inheritance graph
[legend]
Collaboration diagram for TAO_FlowSpec_Entry:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Direction { TAO_AV_INVALID = -1, TAO_AV_DIR_IN = 0, TAO_AV_DIR_OUT = 1 }
enum  Role { TAO_AV_INVALID_ROLE = -1, TAO_AV_PRODUCER = 0, TAO_AV_CONSUMER = 1 }

Public Methods

 TAO_FlowSpec_Entry (void)
 default constructor. More...

 TAO_FlowSpec_Entry (const char *flowname, const char *direction, const char *format_name, const char *flow_protocol, const char *carrier_protocol, ACE_Addr *address, ACE_Addr *control_address=0)
 constructor to construct an entry from the arguments. More...

 TAO_FlowSpec_Entry (const char *flowname, const char *direction, const char *format_name, const char *flow_protocol, const char *address)
virtual int parse (const char *flowSpec_entry)=0
 construct the entry from a string specified by the flowSpec grammar. More...

virtual ~TAO_FlowSpec_Entry (void)
 virtual destructor. More...

int direction (void)
 accessor to the direction. More...

virtual Role role (void)=0
void role (Role role)
const char * direction_str (void) const
 accessor to string version of direction . More...

const char * flow_protocol_str (void) const
 accessor to the flow protocol string. More...

void flow_protocol_str (const char *flow_protocol_str)
 set the flow protocol string. More...

ACE_Addraddress (void)
 accessor to address of the carrier protocol. More...

ACE_Addrcontrol_address (void)
void address (ACE_Addr *address)
void control_address (ACE_Addr *address)
const char * address_str (void) const
 Address in string format i. hostname:port. More...

TAO_AV_Core::Protocol carrier_protocol (void)
 accessor to carrier protocol i.e TCP,UDP,RTP/UDP. More...

const char * carrier_protocol_str (void) const
 accessor to string version of carrier protocol. More...

const char * format (void) const
 accessor to format to be used for this flow. More...

const char * flowname (void) const
 accessor to name of this flow. More...

virtual const char * entry_to_string (void)=0
 converts the entry to a string. More...

int set_peer_addr (ACE_Addr *peer_addr)
ACE_Addrget_peer_addr (void)
int set_peer_control_addr (ACE_Addr *peer_control_addr)
ACE_Addrget_peer_control_addr (void)
int set_local_addr (ACE_Addr *local_addr)
ACE_Addrget_local_addr (void)
char * get_local_addr_str (void)
int set_local_control_addr (ACE_Addr *local_control_addr)
ACE_Addrget_local_control_addr (void)
char * get_local_control_addr_str (void)
TAO_AV_Transporttransport (void)
void transport (TAO_AV_Transport *transport)
TAO_AV_Transportcontrol_transport (void)
void control_transport (TAO_AV_Transport *control_transport)
TAO_AV_Flow_Handlerhandler (void)
void handler (TAO_AV_Flow_Handler *handler)
TAO_AV_Flow_Handlercontrol_handler (void)
void control_handler (TAO_AV_Flow_Handler *control_handler)
TAO_AV_Protocol_Objectprotocol_object (void)
void protocol_object (TAO_AV_Protocol_Object *object)
TAO_AV_Protocol_Objectcontrol_protocol_object (void)
void control_protocol_object (TAO_AV_Protocol_Object *object)
int parse_address (const char *format_string, TAO_AV_Core::Flow_Component flow_component)
 sets the address for this flow. More...

int is_multicast (void)
 returns true for a multicast address. More...


Protected Methods

int parse_flow_protocol_string (const char *flow_options_string)
 parses the flow protocol string with tokens separated by :. More...

int set_direction (const char *direction_string)
 sets the direction flag. More...

int set_protocol (void)
 sets the protocol_ enum from the carrier_protocol_ string. More...


Protected Attributes

ACE_Addraddress_
 Addr information for the carrier protocol. More...

int clean_up_address_
ACE_Addrcontrol_address_
int clean_up_control_address_
ACE_CString address_str_
 Addr in string format i.e hostname:port. More...

ACE_CString format_
 format string. More...

Direction direction_
 Direction of this flow. More...

ACE_CString direction_str_
 string representation of the direction. More...

ACE_CString flowname_
 name of this flow. More...

TAO_AV_Core::Protocol protocol_
 name of the protocol used. More...

ACE_CString carrier_protocol_
 carrier protocol string. More...

ACE_CString flow_protocol_
 flow protocol string. More...

int use_flow_protocol_
ACE_CString entry_
 The flowspec entry;. More...

int is_multicast_
ACE_Addrpeer_addr_
ACE_Addrpeer_control_addr_
ACE_Addrlocal_addr_
ACE_Addrlocal_control_addr_
TAO_AV_Transporttransport_
TAO_AV_Transportcontrol_transport_
TAO_AV_Flow_Handlerhandler_
TAO_AV_Flow_Handlercontrol_handler_
TAO_AV_Protocol_Objectprotocol_object_
TAO_AV_Protocol_Objectcontrol_protocol_object_
Role role_

Detailed Description

A helper entry class in the flow spec sequence passed to bind_devs.


Member Enumeration Documentation

enum TAO_FlowSpec_Entry::Direction
 

Enumeration values:
TAO_AV_INVALID 
TAO_AV_DIR_IN 
TAO_AV_DIR_OUT 

enum TAO_FlowSpec_Entry::Role
 

Enumeration values:
TAO_AV_INVALID_ROLE 
TAO_AV_PRODUCER 
TAO_AV_CONSUMER 


Constructor & Destructor Documentation

TAO_FlowSpec_Entry::TAO_FlowSpec_Entry void   
 

default constructor.

TAO_FlowSpec_Entry::TAO_FlowSpec_Entry const char *    flowname,
const char *    direction,
const char *    format_name,
const char *    flow_protocol,
const char *    carrier_protocol,
ACE_Addr   address,
ACE_Addr   control_address = 0
 

constructor to construct an entry from the arguments.

TAO_FlowSpec_Entry::TAO_FlowSpec_Entry const char *    flowname,
const char *    direction,
const char *    format_name,
const char *    flow_protocol,
const char *    address
 

TAO_FlowSpec_Entry::~TAO_FlowSpec_Entry void    [virtual]
 

virtual destructor.


Member Function Documentation

ACE_INLINE void TAO_FlowSpec_Entry::address ACE_Addr   addr
 

ACE_INLINE ACE_Addr * TAO_FlowSpec_Entry::address void   
 

accessor to address of the carrier protocol.

ACE_INLINE const char * TAO_FlowSpec_Entry::address_str void    const
 

Address in string format i. hostname:port.

ACE_INLINE TAO_AV_Core::Protocol TAO_FlowSpec_Entry::carrier_protocol void   
 

accessor to carrier protocol i.e TCP,UDP,RTP/UDP.

ACE_INLINE const char * TAO_FlowSpec_Entry::carrier_protocol_str void    const
 

accessor to string version of carrier protocol.

ACE_INLINE void TAO_FlowSpec_Entry::control_address ACE_Addr   addr
 

ACE_INLINE ACE_Addr * TAO_FlowSpec_Entry::control_address void   
 

ACE_INLINE void TAO_FlowSpec_Entry::control_handler TAO_AV_Flow_Handler   handler
 

ACE_INLINE TAO_AV_Flow_Handler * TAO_FlowSpec_Entry::control_handler void   
 

ACE_INLINE void TAO_FlowSpec_Entry::control_protocol_object TAO_AV_Protocol_Object   object
 

ACE_INLINE TAO_AV_Protocol_Object * TAO_FlowSpec_Entry::control_protocol_object void   
 

ACE_INLINE void TAO_FlowSpec_Entry::control_transport TAO_AV_Transport   control_transport
 

ACE_INLINE TAO_AV_Transport * TAO_FlowSpec_Entry::control_transport void   
 

ACE_INLINE int TAO_FlowSpec_Entry::direction void   
 

accessor to the direction.

ACE_INLINE const char * TAO_FlowSpec_Entry::direction_str void    const
 

accessor to string version of direction .

virtual const char* TAO_FlowSpec_Entry::entry_to_string void    [pure virtual]
 

converts the entry to a string.

Reimplemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

ACE_INLINE void TAO_FlowSpec_Entry::flow_protocol_str const char *    str
 

set the flow protocol string.

ACE_INLINE const char * TAO_FlowSpec_Entry::flow_protocol_str void    const
 

accessor to the flow protocol string.

ACE_INLINE const char * TAO_FlowSpec_Entry::flowname void    const
 

accessor to name of this flow.

ACE_INLINE const char * TAO_FlowSpec_Entry::format void    const
 

accessor to format to be used for this flow.

ACE_INLINE ACE_Addr * TAO_FlowSpec_Entry::get_local_addr void   
 

char * TAO_FlowSpec_Entry::get_local_addr_str void   
 

ACE_INLINE ACE_Addr * TAO_FlowSpec_Entry::get_local_control_addr void   
 

char* TAO_FlowSpec_Entry::get_local_control_addr_str void   
 

ACE_INLINE ACE_Addr * TAO_FlowSpec_Entry::get_peer_addr void   
 

ACE_Addr* TAO_FlowSpec_Entry::get_peer_control_addr void   
 

ACE_INLINE void TAO_FlowSpec_Entry::handler TAO_AV_Flow_Handler   handler
 

ACE_INLINE TAO_AV_Flow_Handler * TAO_FlowSpec_Entry::handler void   
 

ACE_INLINE int TAO_FlowSpec_Entry::is_multicast void   
 

returns true for a multicast address.

virtual int TAO_FlowSpec_Entry::parse const char *    flowSpec_entry [pure virtual]
 

construct the entry from a string specified by the flowSpec grammar.

Reimplemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

int TAO_FlowSpec_Entry::parse_address const char *    address,
TAO_AV_Core::Flow_Component    flow_comp
 

sets the address for this flow.

ACE_INLINE int TAO_FlowSpec_Entry::parse_flow_protocol_string const char *    flow_string [protected]
 

parses the flow protocol string with tokens separated by :.

ACE_INLINE void TAO_FlowSpec_Entry::protocol_object TAO_AV_Protocol_Object   object
 

ACE_INLINE TAO_AV_Protocol_Object * TAO_FlowSpec_Entry::protocol_object void   
 

ACE_INLINE void TAO_FlowSpec_Entry::role TAO_FlowSpec_Entry::Role    role
 

virtual Role TAO_FlowSpec_Entry::role void    [pure virtual]
 

Reimplemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

ACE_INLINE int TAO_FlowSpec_Entry::set_direction const char *    direction [protected]
 

sets the direction flag.

ACE_INLINE int TAO_FlowSpec_Entry::set_local_addr ACE_Addr   local_addr
 

ACE_INLINE int TAO_FlowSpec_Entry::set_local_control_addr ACE_Addr   local_addr
 

ACE_INLINE int TAO_FlowSpec_Entry::set_peer_addr ACE_Addr   peer_addr
 

int TAO_FlowSpec_Entry::set_peer_control_addr ACE_Addr   peer_control_addr
 

int TAO_FlowSpec_Entry::set_protocol void    [protected]
 

sets the protocol_ enum from the carrier_protocol_ string.

ACE_INLINE void TAO_FlowSpec_Entry::transport TAO_AV_Transport   transport
 

ACE_INLINE TAO_AV_Transport * TAO_FlowSpec_Entry::transport void   
 


Member Data Documentation

ACE_Addr* TAO_FlowSpec_Entry::address_ [protected]
 

Addr information for the carrier protocol.

ACE_CString TAO_FlowSpec_Entry::address_str_ [protected]
 

Addr in string format i.e hostname:port.

ACE_CString TAO_FlowSpec_Entry::carrier_protocol_ [protected]
 

carrier protocol string.

int TAO_FlowSpec_Entry::clean_up_address_ [protected]
 

int TAO_FlowSpec_Entry::clean_up_control_address_ [protected]
 

ACE_Addr* TAO_FlowSpec_Entry::control_address_ [protected]
 

TAO_AV_Flow_Handler* TAO_FlowSpec_Entry::control_handler_ [protected]
 

TAO_AV_Protocol_Object* TAO_FlowSpec_Entry::control_protocol_object_ [protected]
 

TAO_AV_Transport* TAO_FlowSpec_Entry::control_transport_ [protected]
 

Direction TAO_FlowSpec_Entry::direction_ [protected]
 

Direction of this flow.

ACE_CString TAO_FlowSpec_Entry::direction_str_ [protected]
 

string representation of the direction.

ACE_CString TAO_FlowSpec_Entry::entry_ [protected]
 

The flowspec entry;.

ACE_CString TAO_FlowSpec_Entry::flow_protocol_ [protected]
 

flow protocol string.

ACE_CString TAO_FlowSpec_Entry::flowname_ [protected]
 

name of this flow.

ACE_CString TAO_FlowSpec_Entry::format_ [protected]
 

format string.

TAO_AV_Flow_Handler* TAO_FlowSpec_Entry::handler_ [protected]
 

int TAO_FlowSpec_Entry::is_multicast_ [protected]
 

ACE_Addr* TAO_FlowSpec_Entry::local_addr_ [protected]
 

ACE_Addr* TAO_FlowSpec_Entry::local_control_addr_ [protected]
 

ACE_Addr* TAO_FlowSpec_Entry::peer_addr_ [protected]
 

ACE_Addr* TAO_FlowSpec_Entry::peer_control_addr_ [protected]
 

TAO_AV_Core::Protocol TAO_FlowSpec_Entry::protocol_ [protected]
 

name of the protocol used.

TAO_AV_Protocol_Object* TAO_FlowSpec_Entry::protocol_object_ [protected]
 

Role TAO_FlowSpec_Entry::role_ [protected]
 

TAO_AV_Transport* TAO_FlowSpec_Entry::transport_ [protected]
 

int TAO_FlowSpec_Entry::use_flow_protocol_ [protected]
 


The documentation for this class was generated from the following files:
Generated on Fri Nov 22 10:58:30 2002 for TAO_AV by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001