TAO_DIOP_Profile Class Reference

This class defines the protocol specific attributes required for locating ORBs over a TCP/IP network. More...

#include <DIOP_Profile.h>

Inheritance diagram for TAO_DIOP_Profile:

[legend]Collaboration diagram for TAO_DIOP_Profile:

[legend]List of all members.

Public Member Functions
virtual char	object_key_delimiter (void) const
	TAO_DIOP_Profile (const ACE_INET_Addr &addr, const TAO::ObjectKey &object_key, const TAO_GIOP_Message_Version &version, TAO_ORB_Core *orb_core)
	TAO_DIOP_Profile (const char *host, CORBA::UShort port, const TAO::ObjectKey &object_key, const ACE_INET_Addr &addr, const TAO_GIOP_Message_Version &version, TAO_ORB_Core *orb_core)
	TAO_DIOP_Profile (TAO_ORB_Core *orb_core)
	Profile constructor, default.
	~TAO_DIOP_Profile (void)
	Destructor is to be called only through .
virtual char *	to_string ()
	Template methods. Please tao/Profile.h for documentation.
virtual int	encode_endpoints (void)
virtual TAO_Endpoint *	endpoint (void)
virtual CORBA::ULong	endpoint_count (void) const
virtual CORBA::ULong	hash (CORBA::ULong max)
void	add_endpoint (TAO_DIOP_Endpoint *endp)
Static Public Member Functions
const char *	prefix (void)
	Return the char string prefix.
Static Public Attributes
const char	object_key_delimiter_ = '/'
	The object key delimiter that DIOP uses or expects.
Protected Member Functions
virtual int	decode_profile (TAO_InputCDR &cdr)
	Template methods. Please see tao/Profile.h for documentation.
virtual void	parse_string_i (const char *string)
virtual void	create_profile_body (TAO_OutputCDR &cdr) const
virtual int	decode_endpoints (void)
virtual CORBA::Boolean	do_is_equivalent (const TAO_Profile *other_profile)
Protected Attributes
TAO_DIOP_Endpoint	endpoint_
CORBA::ULong	count_
	Number of endpoints in the list headed by .

---

Detailed Description

This class defines the protocol specific attributes required for locating ORBs over a TCP/IP network.

This class defines the DIOP profile as specified in the CORBA specification.

Definition at line 45 of file DIOP_Profile.h.

---

Constructor & Destructor Documentation

TAO_DIOP_Profile::TAO_DIOP_Profile (  const ACE_INET_Addr &  addr, const TAO::ObjectKey &  object_key, const TAO_GIOP_Message_Version &  version, TAO_ORB_Core *  orb_core )

Profile constructor, same as above except the object_key has already been marshaled. Definition at line 35 of file DIOP_Profile.cpp. References TAO_TAG_DIOP_PROFILE. : TAO_Profile (TAO_TAG_DIOP_PROFILE, orb_core, object_key, version), endpoint_ (addr, orb_core->orb_params ()->use_dotted_decimal_addresses ()), count_ (1) { }

TAO_DIOP_Profile::TAO_DIOP_Profile (  const char *  host, CORBA::UShort  port, const TAO::ObjectKey &  object_key, const ACE_INET_Addr &  addr, const TAO_GIOP_Message_Version &  version, TAO_ORB_Core *  orb_core )

Profile constructor, this is the most efficient since it doesn't require any address resolution processing. Definition at line 49 of file DIOP_Profile.cpp. References TAO_TAG_DIOP_PROFILE. : TAO_Profile (TAO_TAG_DIOP_PROFILE, orb_core, object_key, version), endpoint_ (host, port, addr), count_ (1) { }

TAO_DIOP_Profile::TAO_DIOP_Profile (  TAO_ORB_Core *  orb_core  )

Profile constructor, default. Definition at line 64 of file DIOP_Profile.cpp. References TAO_DEF_GIOP_MAJOR, TAO_DEF_GIOP_MINOR, and TAO_TAG_DIOP_PROFILE. : TAO_Profile (TAO_TAG_DIOP_PROFILE, orb_core, TAO_GIOP_Message_Version (TAO_DEF_GIOP_MAJOR, TAO_DEF_GIOP_MINOR)), endpoint_ (), count_ (1) { }

TAO_DIOP_Profile::~TAO_DIOP_Profile (  void   )

Destructor is to be called only through . Definition at line 73 of file DIOP_Profile.cpp. References endpoint(), and TAO_Endpoint::next(). { // Clean up the list of endpoints since we own it. // Skip the head, since it is not dynamically allocated. TAO_Endpoint *tmp = 0; for (TAO_Endpoint *next = this->endpoint ()->next (); next != 0; next = tmp) { tmp = next->next (); delete next; } }

---

Member Function Documentation

void TAO_DIOP_Profile::add_endpoint (  TAO_DIOP_Endpoint *  endp  )

Add to this profile's list of endpoints (it is inserted next to the head of the list). This profiles takes ownership of . Definition at line 283 of file DIOP_Profile.cpp. References TAO_DIOP_Endpoint::next_. Referenced by TAO_DIOP_Acceptor::create_shared_profile(), and decode_endpoints(). { endp->next_ = this->endpoint_.next_; this->endpoint_.next_ = endp; this->count_++; }

void TAO_DIOP_Profile::create_profile_body (  TAO_OutputCDR &  cdr  )  const [protected, virtual]

Implements TAO_Profile. Definition at line 336 of file DIOP_Profile.cpp. References ACE_ERROR, TAO_Tagged_Components::encode(), LM_ERROR, TAO_GIOP_Message_Version::major, TAO_GIOP_Message_Version::minor, TAO::Refcounted_ObjectKey::object_key(), TAO_Profile::tagged_components(), TAO_ENCAP_BYTE_ORDER, ACE_OutputCDR::write_octet(), ACE_OutputCDR::write_string(), and ACE_OutputCDR::write_ushort(). { encap.write_octet (TAO_ENCAP_BYTE_ORDER); // The GIOP version encap.write_octet (this->version_.major); encap.write_octet (this->version_.minor); // STRING hostname from profile encap.write_string (this->endpoint_.host ()); // UNSIGNED SHORT port number encap.write_ushort (this->endpoint_.port ()); // OCTET SEQUENCE for object key if (this->ref_object_key_) encap << this->ref_object_key_->object_key (); else { ACE_ERROR ((LM_ERROR, "(%P|%t) TAO - UIOP_Profile::create_profile_body " "no object key marshalled \n")); } if (this->version_.major > 1 || this->version_.minor > 0) this->tagged_components ().encode (encap); }

int TAO_DIOP_Profile::decode_endpoints (  void   )  [protected, virtual]

Implements TAO_Profile. Definition at line 422 of file DIOP_Profile.cpp. References ACE_NEW_RETURN, add_endpoint(), IOP::TaggedComponent::component_data, TAO::unbounded_value_sequence< T >::get_buffer(), TAO_Tagged_Components::get_component(), TAO::unbounded_value_sequence< IIOP_Endpoint_Info >::length(), TAO::unbounded_value_sequence< T >::length(), TAO_Endpoint::priority(), ACE_InputCDR::reset_byte_order(), and IOP::TaggedComponent::tag. { IOP::TaggedComponent tagged_component; tagged_component.tag = TAO_TAG_ENDPOINTS; if (this->tagged_components_.get_component (tagged_component)) { const CORBA::Octet *buf = tagged_component.component_data.get_buffer (); TAO_InputCDR in_cdr (reinterpret_cast<const char*> (buf), tagged_component.component_data.length ()); // Extract the Byte Order. CORBA::Boolean byte_order; if ((in_cdr >> ACE_InputCDR::to_boolean (byte_order)) == 0) return -1; in_cdr.reset_byte_order (static_cast<int> (byte_order)); // Extract endpoints sequence. TAO::IIOPEndpointSequence endpoints; if ((in_cdr >> endpoints) == 0) return -1; // Get the priority of the first endpoint (head of the list. // It's other data is extracted as part of the standard profile // decoding. this->endpoint_.priority (endpoints[0].priority); // Use information extracted from the tagged component to // populate the profile. Skip the first endpoint, since it is // always extracted through standard profile body. Also, begin // from the end of the sequence to preserve endpoint order, // since <add_endpoint> method reverses the order of endpoints // in the list. for (CORBA::ULong i = endpoints.length () - 1; i > 0; --i) { TAO_DIOP_Endpoint *endpoint = 0; ACE_NEW_RETURN (endpoint, TAO_DIOP_Endpoint (endpoints[i].host, endpoints[i].port, endpoints[i].priority), -1); this->add_endpoint (endpoint); } } return 0; }

int TAO_DIOP_Profile::decode_profile (  TAO_InputCDR &  cdr  )  [protected, virtual]

Template methods. Please see tao/Profile.h for documentation. Implements TAO_Profile. Definition at line 94 of file DIOP_Profile.cpp. References ACE_DEBUG, ACE_TEXT, ACE_InputCDR::good_bit(), LM_DEBUG, TAO_DIOP_Endpoint::object_addr_, ACE_InputCDR::read_string(), ACE_InputCDR::read_ushort(), ACE_Addr::set_type(), and TAO_debug_level. { // @@ NOTE: This code is repeated thrice. Need to factor out in a // better manner. // Decode host and port into the <endpoint_>. if (cdr.read_string (this->endpoint_.host_.out ()) == 0 || cdr.read_ushort (this->endpoint_.port_) == 0) { if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) DIOP_Profile::decode - ") ACE_TEXT ("error while decoding host/port"))); return -1; } if (cdr.good_bit ()) { // Invalidate the object_addr_ until first access. this->endpoint_.object_addr_.set_type (-1); return 1; } return -1; }

CORBA::Boolean TAO_DIOP_Profile::do_is_equivalent (  const TAO_Profile *  other_profile  )  [protected, virtual]

Implements TAO_Profile. Definition at line 220 of file DIOP_Profile.cpp. References endpoint_, TAO_DIOP_Endpoint::is_equivalent(), and TAO_DIOP_Endpoint::next_. { const TAO_DIOP_Profile *op = dynamic_cast<const TAO_DIOP_Profile *> (other_profile); // Check endpoints equivalence. const TAO_DIOP_Endpoint *other_endp = &op->endpoint_; for (TAO_DIOP_Endpoint *endp = &this->endpoint_; endp != 0; endp = endp->next_) { if (endp->is_equivalent (other_endp)) other_endp = other_endp->next_; else return 0; } return 1; }

int TAO_DIOP_Profile::encode_endpoints (  void   )  [virtual]

Implements TAO_Profile. Definition at line 366 of file DIOP_Profile.cpp. References ACE_OutputCDR::begin(), IOP::TaggedComponent::component_data, ACE_Message_Block::cont(), TAO::unbounded_value_sequence< T >::get_buffer(), TAO_DIOP_Endpoint::host(), ACE_Message_Block::length(), TAO::unbounded_value_sequence< T >::length(), TAO::unbounded_value_sequence< IIOP_Endpoint_Info >::length(), ACE_OS::memcpy(), TAO_DIOP_Endpoint::next_, TAO_DIOP_Endpoint::port(), TAO_Endpoint::priority(), ACE_Message_Block::rd_ptr(), TAO_Tagged_Components::set_component(), IOP::TaggedComponent::tag, TAO_ENCAP_BYTE_ORDER, and ACE_OutputCDR::total_length(). { // Create a data structure and fill it with endpoint info for wire // transfer. // We include information for the head of the list // together with other endpoints because even though its addressing // info is transmitted using standard ProfileBody components, its // priority is not! TAO::IIOPEndpointSequence endpoints; endpoints.length (this->count_); const TAO_DIOP_Endpoint *endpoint = &this->endpoint_; for (CORBA::ULong i = 0; i < this->count_; ++i) { endpoints[i].host = endpoint->host (); endpoints[i].port = endpoint->port (); endpoints[i].priority = endpoint->priority (); endpoint = endpoint->next_; } // Encode the data structure. TAO_OutputCDR out_cdr; if ((out_cdr << ACE_OutputCDR::from_boolean (TAO_ENCAP_BYTE_ORDER) == 0) || (out_cdr << endpoints) == 0) return -1; size_t length = out_cdr.total_length (); IOP::TaggedComponent tagged_component; tagged_component.tag = TAO_TAG_ENDPOINTS; tagged_component.component_data.length (static_cast<CORBA::ULong> (length)); CORBA::Octet *buf = tagged_component.component_data.get_buffer (); for (const ACE_Message_Block *iterator = out_cdr.begin (); iterator != 0; iterator = iterator->cont ()) { size_t i_length = iterator->length (); ACE_OS::memcpy (buf, iterator->rd_ptr (), i_length); buf += i_length; } // Add component with encoded endpoint data to this profile's // TaggedComponents. tagged_components_.set_component (tagged_component); return 0; }

TAO_Endpoint * TAO_DIOP_Profile::endpoint (  void   )  [virtual]

Implements TAO_Profile. Definition at line 271 of file DIOP_Profile.cpp. Referenced by TAO_DIOP_Acceptor::create_new_profile(), TAO_DIOP_Acceptor::create_shared_profile(), and ~TAO_DIOP_Profile(). { return &this->endpoint_; }

CORBA::ULong TAO_DIOP_Profile::endpoint_count (  void   )  const [virtual]

Implements TAO_Profile. Definition at line 277 of file DIOP_Profile.cpp. { return this->count_; }

CORBA::ULong TAO_DIOP_Profile::hash (  CORBA::ULong  max  )  [virtual]

Implements TAO_Profile. Definition at line 241 of file DIOP_Profile.cpp. References TAO_DIOP_Endpoint::hash(), TAO_Profile::hash_service_i(), TAO::unbounded_value_sequence< T >::length(), TAO_GIOP_Message_Version::minor, TAO_DIOP_Endpoint::next_, TAO::Refcounted_ObjectKey::object_key(), and TAO_Profile::tag(). { // Get the hashvalue for all endpoints. CORBA::ULong hashval = 0; for (TAO_DIOP_Endpoint *endp = &this->endpoint_; endp != 0; endp = endp->next_) { hashval += endp->hash (); } hashval += this->version_.minor; hashval += this->tag (); const TAO::ObjectKey &ok = this->ref_object_key_->object_key (); if (ok.length () >= 4) { hashval += ok[1]; hashval += ok[3]; } hashval += this->hash_service_i (max); return hashval % max; }

char TAO_DIOP_Profile::object_key_delimiter (  void   )  const [virtual]

Implements TAO_Profile. Definition at line 29 of file DIOP_Profile.cpp. References object_key_delimiter_. { return TAO_DIOP_Profile::object_key_delimiter_; }

void TAO_DIOP_Profile::parse_string_i (  const char *  string  )  [protected, virtual]

Implements TAO_Profile. Definition at line 121 of file DIOP_Profile.cpp. References ACE_DEBUG, ACE_TEXT, ACE_THROW, ACE_OS::atoi(), TAO::ObjectKey_Table::bind(), TAO::ObjectKey::decode_string_to_sequence(), ACE_INET_Addr::get_host_name(), TAO_DIOP_Endpoint::host_, LM_DEBUG, MAXHOSTNAMELEN, TAO_ORB_Core::object_key_table(), TAO_Profile::orb_core(), TAO_DIOP_Endpoint::port_, ACE_OS::strchr(), ACE_OS::strcmp(), CORBA::string_alloc(), CORBA::string_dup(), ACE_OS::strncpy(), and TAO_debug_level. { // Pull off the "hostname:port/" part of the objref // Copy the string because we are going to modify it... const char *okd = ACE_OS::strchr (ior, this->object_key_delimiter_); if (okd == 0 || okd == ior) { // No object key delimiter or no hostname specified. ACE_THROW (CORBA::INV_OBJREF ( CORBA::SystemException::_tao_minor_code ( TAO::VMCID, EINVAL), CORBA::COMPLETED_NO)); } // Length of host string. CORBA::ULong length_host = 0; const char *cp_pos = ACE_OS::strchr (ior, ':'); // Look for a port if (cp_pos == ior) { // No hostname specified! It is required by the spec. ACE_THROW (CORBA::INV_OBJREF ( CORBA::SystemException::_tao_minor_code ( TAO::VMCID, EINVAL), CORBA::COMPLETED_NO)); } else if (cp_pos != 0) { // A port number or port name was specified. CORBA::ULong length_port = okd - cp_pos - 1; CORBA::String_var tmp = CORBA::string_alloc (length_port); ACE_OS::strncpy (tmp.inout (), cp_pos + 1, length_port); tmp[length_port] = '\0'; this->endpoint_.port_ = static_cast<CORBA::UShort> (ACE_OS::atoi (tmp.in ())); length_host = cp_pos - ior; } else length_host = okd - ior; CORBA::String_var tmp = CORBA::string_alloc (length_host); // Skip the trailing '/' ACE_OS::strncpy (tmp.inout (), ior, length_host); tmp[length_host] = '\0'; this->endpoint_.host_ = tmp._retn (); if (ACE_OS::strcmp (this->endpoint_.host_.in (), "") == 0) { ACE_INET_Addr host_addr; char tmp_host [MAXHOSTNAMELEN + 1]; // If no host is specified: assign the default host, i.e. the // local host. if (host_addr.get_host_name (tmp_host, sizeof (tmp_host)) != 0) { // Can't get the IP address since the INET_Addr wasn't // initialized. Just throw an exception. if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\n\nTAO (%P|%t) ") ACE_TEXT ("IIOP_Profile::parse_string ") ACE_TEXT ("- %p\n\n"), ACE_TEXT ("cannot determine hostname"))); // @@ What's the right exception to throw here? ACE_THROW (CORBA::INV_OBJREF ( CORBA::SystemException::_tao_minor_code ( TAO::VMCID, EINVAL), CORBA::COMPLETED_NO)); } else this->endpoint_.host_ = CORBA::string_dup (tmp_host); } TAO::ObjectKey ok; TAO::ObjectKey::decode_string_to_sequence (ok, okd + 1); (void) this->orb_core ()->object_key_table ().bind (ok, this->ref_object_key_); }

const char * TAO_DIOP_Profile::prefix (  void   )  [static]

Return the char string prefix. Definition at line 330 of file DIOP_Profile.cpp. { return ::the_prefix; }

char * TAO_DIOP_Profile::to_string (   )  [virtual]

Template methods. Please tao/Profile.h for documentation. Implements TAO_Profile. Definition at line 292 of file DIOP_Profile.cpp. References TAO::ObjectKey::encode_sequence_to_string(), TAO::Refcounted_ObjectKey::object_key(), object_key_delimiter_, TAO_DIOP_Endpoint::port(), ACE_OS::sprintf(), CORBA::string_alloc(), ACE_OS::strlen(), and the_prefix. { CORBA::String_var key; TAO::ObjectKey::encode_sequence_to_string (key.inout(), this->ref_object_key_->object_key ()); size_t buflen = (8 /* "corbaloc" */ + 1 /* colon separator */ + ACE_OS::strlen (::the_prefix) + 1 /* colon separator */ + 1 /* major version */ + 1 /* decimal point */ + 1 /* minor version */ + 1 /* `@' character */ + ACE_OS::strlen (this->endpoint_.host ()) + 1 /* colon separator */ + 5 /* port number */ + 1 /* object key separator */ + ACE_OS::strlen (key.in ())); char * buf = CORBA::string_alloc (static_cast<CORBA::ULong> (buflen)); static const char digits [] = "0123456789"; ACE_OS::sprintf (buf, "corbaloc:%s:%c.%c@%s:%d%c%s", ::the_prefix, digits [this->version_.major], digits [this->version_.minor], this->endpoint_.host (), this->endpoint_.port (), this->object_key_delimiter_, key.in ()); return buf; }

---

Member Data Documentation

CORBA::ULong TAO_DIOP_Profile::count_ [protected]

Number of endpoints in the list headed by . Definition at line 123 of file DIOP_Profile.h.

TAO_DIOP_Endpoint TAO_DIOP_Profile::endpoint_ [protected]

Head of this profile's list of endpoints. This endpoint is not dynamically allocated because a profile always contains at least one endpoint. Currently, a profile contains more than one endpoint, i.e., list contains more than just the head, only when RTCORBA is enabled. However, in the near future, this will be used in nonRT mode as well, e.g., to support TAG_ALTERNATE_DIOP_ADDRESS feature. Addressing info of the default endpoint, i.e., head of the list, is transmitted using standard DIOP ProfileBody components. See method documentation above for how the rest of the endpoint list is transmitted. Definition at line 120 of file DIOP_Profile.h. Referenced by do_is_equivalent().

TAO_BEGIN_VERSIONED_NAMESPACE_DECL const char TAO_DIOP_Profile::object_key_delimiter_ = '/' [static]

The object key delimiter that DIOP uses or expects. Definition at line 26 of file DIOP_Profile.cpp. Referenced by object_key_delimiter(), and to_string().

---

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

• DIOP_Profile.h
• DIOP_Profile.cpp

---