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:

Collaboration diagram for TAO_FlowSpec_Entry:

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 Member Functions
	TAO_FlowSpec_Entry ()
	default constructor.
	TAO_FlowSpec_Entry (const char *flowname, const char *direction, const char *format_name, const char *flow_protocol, const char *carrier_protocol, ACE_Addr *fwd_address, ACE_Addr *control_address=0)
	constructor to construct an entry from the arguments.
	TAO_FlowSpec_Entry (const char *flowname, const char *direction, const char *format_name, const char *flow_protocol, const char *fwd_address)
virtual int	parse (const char *flowSpec_entry)=0
	construct the entry from a string specified by the flowSpec grammar.
virtual	~TAO_FlowSpec_Entry ()
	virtual destructor.
int	direction ()
	accessor to the direction.
virtual Role	role ()=0
void	role (Role role)
const char *	direction_str () const
	accessor to string version of direction .
const char *	flow_protocol_str () const
	accessor to the flow protocol string.
void	flow_protocol_str (const char *flow_protocol_str)
	set the flow protocol string.
ACE_Addr *	address ()
	accessor to address of the carrier protocol.
ACE_Addr *	control_address ()
void	address (ACE_Addr *address, bool cleanup=false)
void	control_address (ACE_Addr *address)
const char *	address_str () const
	Address in string format i. hostname:port.
TAO_AV_Core::Protocol	carrier_protocol ()
	accessor to carrier protocol i.e TCP,UDP,RTP/UDP.
const char *	carrier_protocol_str () const
	accessor to string version of carrier protocol.
const char *	format () const
	accessor to format to be used for this flow.
const char *	flowname () const
	accessor to name of this flow.
virtual const char *	entry_to_string ()=0
	converts the entry to a string.
int	set_peer_addr (ACE_Addr *peer_addr)
ACE_Addr *	get_peer_addr ()
int	set_peer_control_addr (ACE_Addr *peer_control_addr)
ACE_Addr *	get_peer_control_addr ()
int	set_local_sec_addr (char **local_sec_addr, int size)
char **	get_local_sec_addr ()
int	num_local_sec_addrs ()
int	set_peer_sec_addr (char **peer_sec_addr, int size)
char **	get_peer_sec_addr ()
int	num_peer_sec_addrs ()
int	set_local_addr (ACE_Addr *local_addr)
ACE_Addr *	get_local_addr ()
char *	get_local_addr_str ()
int	set_local_control_addr (ACE_Addr *local_control_addr)
ACE_Addr *	get_local_control_addr ()
char *	get_local_control_addr_str ()
TAO_AV_Transport *	transport ()
void	transport (TAO_AV_Transport *transport)
TAO_AV_Transport *	control_transport ()
void	control_transport (TAO_AV_Transport *control_transport)
TAO_AV_Flow_Handler *	handler ()
void	handler (TAO_AV_Flow_Handler *handler)
TAO_AV_Flow_Handler *	control_handler ()
void	control_handler (TAO_AV_Flow_Handler *control_handler)
TAO_AV_Protocol_Object *	protocol_object ()
void	protocol_object (TAO_AV_Protocol_Object *object)
TAO_AV_Protocol_Object *	control_protocol_object ()
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.
int	is_multicast ()
	returns true for a multicast address.

Protected Member Functions
int	parse_flow_protocol_string (const char *flow_options_string)
	parses the flow protocol string with tokens separated by :
int	set_direction (const char *direction_string)
	sets the direction flag.
int	set_protocol ()
	sets the protocol_ enum from the carrier_protocol_ string.

Protected Attributes
ACE_Addr *	address_
	Addr information for the carrier protocol.
int	clean_up_address_
ACE_Addr *	control_address_
int	clean_up_control_address_
ACE_CString	address_str_
	Fwd Addr in string format i.e hostname:port.
ACE_CString	peer_address_str_
	Peer Addr in string format i.e hostname:port.
ACE_CString	format_
	format string.
Direction	direction_
	Direction of this flow.
ACE_CString	direction_str_
	string representation of the direction.
ACE_CString	flowname_
	name of this flow.
TAO_AV_Core::Protocol	protocol_
	name of the protocol used.
ACE_CString	carrier_protocol_
	carrier protocol string.
ACE_CString	flow_protocol_
	flow protocol string.
int	use_flow_protocol_
ACE_CString	entry_
	The flowspec entry;.
int	is_multicast_
bool	delete_peer_addr_
ACE_Addr *	peer_addr_
char **	local_sec_addr_
int	num_local_sec_addrs_
char **	peer_sec_addr_
int	num_peer_sec_addrs_
ACE_Addr *	peer_control_addr_
ACE_Addr *	local_addr_
ACE_Addr *	local_control_addr_
TAO_AV_Transport *	transport_
TAO_AV_Transport *	control_transport_
TAO_AV_Flow_Handler *	handler_
TAO_AV_Flow_Handler *	control_handler_
TAO_AV_Protocol_Object *	protocol_object_
TAO_AV_Protocol_Object *	control_protocol_object_
Role	role_

Detailed Description

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

Member Enumeration Documentation

Direction

enum TAO_FlowSpec_Entry::Direction

Enumerator
TAO_AV_INVALID
TAO_AV_DIR_IN
TAO_AV_DIR_OUT

Role

enum TAO_FlowSpec_Entry::Role

Enumerator
TAO_AV_INVALID_ROLE
TAO_AV_PRODUCER
TAO_AV_CONSUMER

Constructor & Destructor Documentation

TAO_FlowSpec_Entry() [1/3]

TAO_FlowSpec_Entry::TAO_FlowSpec_Entry

(

)

default constructor.

TAO_FlowSpec_Entry() [2/3]

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 *	fwd_address,
		ACE_Addr *	control_address = 0 )

constructor to construct an entry from the arguments.

TAO_FlowSpec_Entry() [3/3]

TAO_FlowSpec_Entry::TAO_FlowSpec_Entry	(	const char *	flowname,
		const char *	direction,
		const char *	format_name,
		const char *	flow_protocol,
		const char *	fwd_address )

~TAO_FlowSpec_Entry()

TAO_FlowSpec_Entry::~TAO_FlowSpec_Entry ( )

virtual

virtual destructor.

Member Function Documentation

address() [1/2]

ACE_Addr * TAO_FlowSpec_Entry::address

(

)

accessor to address of the carrier protocol.

address() [2/2]

void TAO_FlowSpec_Entry::address	(	ACE_Addr *	address,
		bool	cleanup = false )

address_str()

const char * TAO_FlowSpec_Entry::address_str

(

)

const

Address in string format i. hostname:port.

carrier_protocol()

TAO_AV_Core::Protocol TAO_FlowSpec_Entry::carrier_protocol

(

)

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

carrier_protocol_str()

const char * TAO_FlowSpec_Entry::carrier_protocol_str

(

)

const

accessor to string version of carrier protocol.

control_address() [1/2]

ACE_Addr * TAO_FlowSpec_Entry::control_address

(

)

control_address() [2/2]

void TAO_FlowSpec_Entry::control_address

(

ACE_Addr *

address

)

control_handler() [1/2]

TAO_AV_Flow_Handler * TAO_FlowSpec_Entry::control_handler

(

)

control_handler() [2/2]

void TAO_FlowSpec_Entry::control_handler

(

TAO_AV_Flow_Handler *

control_handler

)

control_protocol_object() [1/2]

TAO_AV_Protocol_Object * TAO_FlowSpec_Entry::control_protocol_object

(

)

control_protocol_object() [2/2]

void TAO_FlowSpec_Entry::control_protocol_object

(

TAO_AV_Protocol_Object *

object

)

control_transport() [1/2]

TAO_AV_Transport * TAO_FlowSpec_Entry::control_transport

(

)

control_transport() [2/2]

void TAO_FlowSpec_Entry::control_transport

(

TAO_AV_Transport *

control_transport

)

direction()

int TAO_FlowSpec_Entry::direction

(

)

accessor to the direction.

direction_str()

const char * TAO_FlowSpec_Entry::direction_str

(

)

const

accessor to string version of direction .

entry_to_string()

virtual const char * TAO_FlowSpec_Entry::entry_to_string ( )

pure virtual

converts the entry to a string.

Implemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

flow_protocol_str() [1/2]

const char * TAO_FlowSpec_Entry::flow_protocol_str

(

)

const

accessor to the flow protocol string.

flow_protocol_str() [2/2]

void TAO_FlowSpec_Entry::flow_protocol_str

(

const char *

flow_protocol_str

)

set the flow protocol string.

flowname()

const char * TAO_FlowSpec_Entry::flowname

(

)

const

accessor to name of this flow.

format()

const char * TAO_FlowSpec_Entry::format

(

)

const

accessor to format to be used for this flow.

get_local_addr()

ACE_Addr * TAO_FlowSpec_Entry::get_local_addr

(

)

get_local_addr_str()

char * TAO_FlowSpec_Entry::get_local_addr_str

(

)

get_local_control_addr()

ACE_Addr * TAO_FlowSpec_Entry::get_local_control_addr

(

)

get_local_control_addr_str()

char * TAO_FlowSpec_Entry::get_local_control_addr_str

(

)

get_local_sec_addr()

char ** TAO_FlowSpec_Entry::get_local_sec_addr

(

)

get_peer_addr()

ACE_Addr * TAO_FlowSpec_Entry::get_peer_addr

(

)

get_peer_control_addr()

ACE_Addr * TAO_FlowSpec_Entry::get_peer_control_addr

(

)

get_peer_sec_addr()

char ** TAO_FlowSpec_Entry::get_peer_sec_addr

(

)

handler() [1/2]

TAO_AV_Flow_Handler * TAO_FlowSpec_Entry::handler

(

)

handler() [2/2]

void TAO_FlowSpec_Entry::handler

(

TAO_AV_Flow_Handler *

handler

)

is_multicast()

int TAO_FlowSpec_Entry::is_multicast

(

)

returns true for a multicast address.

num_local_sec_addrs()

int TAO_FlowSpec_Entry::num_local_sec_addrs

(

)

num_peer_sec_addrs()

int TAO_FlowSpec_Entry::num_peer_sec_addrs

(

)

parse()

virtual int TAO_FlowSpec_Entry::parse ( const char * flowSpec_entry )

pure virtual

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

Implemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

parse_address()

int TAO_FlowSpec_Entry::parse_address	(	const char *	format_string,
		TAO_AV_Core::Flow_Component	flow_component )

sets the address for this flow.

parse_flow_protocol_string()

int TAO_FlowSpec_Entry::parse_flow_protocol_string ( const char * flow_options_string )

protected

parses the flow protocol string with tokens separated by :

protocol_object() [1/2]

TAO_AV_Protocol_Object * TAO_FlowSpec_Entry::protocol_object

(

)

protocol_object() [2/2]

void TAO_FlowSpec_Entry::protocol_object

(

TAO_AV_Protocol_Object *

object

)

role() [1/2]

virtual Role TAO_FlowSpec_Entry::role ( )

pure virtual

Implemented in TAO_Forward_FlowSpec_Entry, and TAO_Reverse_FlowSpec_Entry.

role() [2/2]

void TAO_FlowSpec_Entry::role

(

TAO_FlowSpec_Entry::Role

role

)

set_direction()

int TAO_FlowSpec_Entry::set_direction ( const char * direction_string )

protected

sets the direction flag.

set_local_addr()

int TAO_FlowSpec_Entry::set_local_addr

(

ACE_Addr *

local_addr

)

set_local_control_addr()

int TAO_FlowSpec_Entry::set_local_control_addr

(

ACE_Addr *

local_control_addr

)

set_local_sec_addr()

int TAO_FlowSpec_Entry::set_local_sec_addr	(	char **	local_sec_addr,
		int	size )

set_peer_addr()

int TAO_FlowSpec_Entry::set_peer_addr

(

ACE_Addr *

peer_addr

)

set_peer_control_addr()

int TAO_FlowSpec_Entry::set_peer_control_addr

(

ACE_Addr *

peer_control_addr

)

set_peer_sec_addr()

int TAO_FlowSpec_Entry::set_peer_sec_addr	(	char **	peer_sec_addr,
		int	size )

set_protocol()

int TAO_FlowSpec_Entry::set_protocol ( )

protected

sets the protocol_ enum from the carrier_protocol_ string.

transport() [1/2]

TAO_AV_Transport * TAO_FlowSpec_Entry::transport

(

)

transport() [2/2]

void TAO_FlowSpec_Entry::transport

(

TAO_AV_Transport *

transport

)

Member Data Documentation

address_

ACE_Addr* TAO_FlowSpec_Entry::address_

protected

Addr information for the carrier protocol.

address_str_

ACE_CString TAO_FlowSpec_Entry::address_str_

protected

Fwd Addr in string format i.e hostname:port.

carrier_protocol_

ACE_CString TAO_FlowSpec_Entry::carrier_protocol_

protected

carrier protocol string.

clean_up_address_

int TAO_FlowSpec_Entry::clean_up_address_

protected

clean_up_control_address_

int TAO_FlowSpec_Entry::clean_up_control_address_

protected

control_address_

ACE_Addr* TAO_FlowSpec_Entry::control_address_

protected

control_handler_

TAO_AV_Flow_Handler* TAO_FlowSpec_Entry::control_handler_

protected

control_protocol_object_

TAO_AV_Protocol_Object* TAO_FlowSpec_Entry::control_protocol_object_

protected

control_transport_

TAO_AV_Transport* TAO_FlowSpec_Entry::control_transport_

protected

delete_peer_addr_

bool TAO_FlowSpec_Entry::delete_peer_addr_

protected

direction_

Direction TAO_FlowSpec_Entry::direction_

protected

Direction of this flow.

direction_str_

ACE_CString TAO_FlowSpec_Entry::direction_str_

protected

string representation of the direction.

entry_

ACE_CString TAO_FlowSpec_Entry::entry_

protected

The flowspec entry;.

flow_protocol_

ACE_CString TAO_FlowSpec_Entry::flow_protocol_

protected

flow protocol string.

flowname_

ACE_CString TAO_FlowSpec_Entry::flowname_

protected

name of this flow.

format_

ACE_CString TAO_FlowSpec_Entry::format_

protected

format string.

handler_

TAO_AV_Flow_Handler* TAO_FlowSpec_Entry::handler_

protected

is_multicast_

int TAO_FlowSpec_Entry::is_multicast_

protected

local_addr_

ACE_Addr* TAO_FlowSpec_Entry::local_addr_

protected

local_control_addr_

ACE_Addr* TAO_FlowSpec_Entry::local_control_addr_

protected

local_sec_addr_

char** TAO_FlowSpec_Entry::local_sec_addr_

protected

num_local_sec_addrs_

int TAO_FlowSpec_Entry::num_local_sec_addrs_

protected

num_peer_sec_addrs_

int TAO_FlowSpec_Entry::num_peer_sec_addrs_

protected

peer_addr_

ACE_Addr* TAO_FlowSpec_Entry::peer_addr_

protected

peer_address_str_

ACE_CString TAO_FlowSpec_Entry::peer_address_str_

protected

Peer Addr in string format i.e hostname:port.

peer_control_addr_

ACE_Addr* TAO_FlowSpec_Entry::peer_control_addr_

protected

peer_sec_addr_

char** TAO_FlowSpec_Entry::peer_sec_addr_

protected

protocol_

TAO_AV_Core::Protocol TAO_FlowSpec_Entry::protocol_

protected

name of the protocol used.

protocol_object_

TAO_AV_Protocol_Object* TAO_FlowSpec_Entry::protocol_object_

protected

role_

Role TAO_FlowSpec_Entry::role_

protected

transport_

TAO_AV_Transport* TAO_FlowSpec_Entry::transport_

protected

use_flow_protocol_

int TAO_FlowSpec_Entry::use_flow_protocol_

protected

---

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

• FlowSpec_Entry.h
• FlowSpec_Entry.cpp
• FlowSpec_Entry.inl