TAO_SCIOP_Profile Class Reference

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

#include <SCIOP_Profile.h>

Inheritance diagram for TAO_SCIOP_Profile:

[legend]Collaboration diagram for TAO_SCIOP_Profile:

[legend]List of all members.

Public Member Functions
virtual char	object_key_delimiter (void) const
	TAO_SCIOP_Profile (const ACE_INET_Addr &addr, const TAO::ObjectKey &object_key, const TAO_GIOP_Message_Version &version, TAO_ORB_Core *orb_core)
	TAO_SCIOP_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_SCIOP_Profile (TAO_ORB_Core *orb_core)
	Profile constructor, default.
	~TAO_SCIOP_Profile (void)
	Destructor is to be called only through .
virtual char *	to_string ()
	Template methods. Please see 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_SCIOP_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 SCIOP uses or expects.
Protected Member Functions
virtual int	decode_profile (TAO_InputCDR &cdr)
	Template methods. Please see Profile.h for the documentation.
virtual int	decode_endpoints (void)
virtual void	parse_string_i (const char *string)
virtual void	create_profile_body (TAO_OutputCDR &cdr) const
virtual CORBA::Boolean	do_is_equivalent (const TAO_Profile *other_profile)
Protected Attributes
TAO_SCIOP_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 SCIOP profile as specified in the CORBA specification.

Definition at line 43 of file SCIOP_Profile.h.

---

Constructor & Destructor Documentation

TAO_SCIOP_Profile::TAO_SCIOP_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 32 of file SCIOP_Profile.cpp. References TAO_TAG_SCIOP_PROFILE. : TAO_Profile (TAO_TAG_SCIOP_PROFILE, orb_core, object_key, version), endpoint_ (addr, orb_core->orb_params ()->use_dotted_decimal_addresses ()), count_ (1) { }

TAO_SCIOP_Profile::TAO_SCIOP_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 46 of file SCIOP_Profile.cpp. References TAO_TAG_SCIOP_PROFILE. : TAO_Profile (TAO_TAG_SCIOP_PROFILE, orb_core, object_key, version), endpoint_ (host, port, addr), count_ (1) { }

TAO_SCIOP_Profile::TAO_SCIOP_Profile (  TAO_ORB_Core *  orb_core  )

Profile constructor, default. Definition at line 61 of file SCIOP_Profile.cpp. References TAO_TAG_SCIOP_PROFILE. : TAO_Profile (TAO_TAG_SCIOP_PROFILE, orb_core, TAO_GIOP_Message_Version (TAO_DEF_SCIOP_MAJOR, TAO_DEF_SCIOP_MINOR)), endpoint_ (), count_ (1) { }

TAO_SCIOP_Profile::~TAO_SCIOP_Profile (  void   )

Destructor is to be called only through . Definition at line 70 of file SCIOP_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_SCIOP_Profile::add_endpoint (  TAO_SCIOP_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 306 of file SCIOP_Profile.cpp. References TAO_SCIOP_Endpoint::next_. Referenced by TAO_SCIOP_Acceptor::create_shared_profile(), decode_endpoints(), and decode_profile(). { endp->next_ = this->endpoint_.next_; this->endpoint_.next_ = endp; this->count_++; }

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

Implements TAO_Profile. Definition at line 359 of file SCIOP_Profile.cpp. References ACE_ERROR, TAO_Tagged_Components::encode(), TAO_SCIOP_Endpoint::host(), TAO::details::unbounded_basic_string_sequence< char >::length(), LM_ERROR, TAO_SCIOP_Endpoint::next_, TAO::Refcounted_ObjectKey::object_key(), TAO_Profile::tagged_components(), TAO_ENCAP_BYTE_ORDER, ACE_OutputCDR::write_octet(), and ACE_OutputCDR::write_ushort(). { encap.write_octet (TAO_ENCAP_BYTE_ORDER); // The SCIOP version encap.write_octet (this->version_.major); encap.write_octet (this->version_.minor); // STRING hostname from profile // encap.write_string (this->endpoint_.host ()); CORBA::StringSeq strseq; strseq.length(this->count_); const TAO_SCIOP_Endpoint *endpoint = &this->endpoint_; for (CORBA::ULong i = 0; i < this->count_; ++i) { strseq[i] = endpoint->host(); endpoint = endpoint->next_; } // strseq[0] = this->endpoint_.host(); encap << strseq; // UNSIGNED SHORT port number encap.write_ushort (this->endpoint_.port ()); // UNSIGNED SHORT max_streams encap.write_ushort (1); // 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 - IIOP_Profile::create_profile_body " "no object key marshalled \n")); } // Tagged Components this->tagged_components ().encode (encap); }

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

Implements TAO_Profile. Definition at line 462 of file SCIOP_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< TAO_SCIOP_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_SCIOPEndpointSequence 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_SCIOP_Endpoint *endpoint = 0; ACE_NEW_RETURN (endpoint, TAO_SCIOP_Endpoint (endpoints[i].host, endpoints[i].port, endpoints[i].priority), -1); this->add_endpoint (endpoint); } } return 0; }

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

Template methods. Please see Profile.h for the documentation. Implements TAO_Profile. Definition at line 86 of file SCIOP_Profile.cpp. References ACE_DEBUG, ACE_NEW_RETURN, ACE_TEXT, add_endpoint(), ACE_InputCDR::good_bit(), TAO_SCIOP_Endpoint::host_, LM_DEBUG, TAO_SCIOP_Endpoint::object_addr_, TAO_SCIOP_Endpoint::preferred_interfaces(), ACE_InputCDR::read_ushort(), ACE_Addr::set_type(), and TAO_debug_level. { // Decode multiple endpoints, starting with the primary (endpoint_) CORBA::StringSeq endpointSeq; cdr >> endpointSeq; this->endpoint_.host_ = endpointSeq[0]; if (cdr.read_ushort (this->endpoint_.port_) == 0) { if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) SCIOP_Profile::decode - ") ACE_TEXT ("error while decoding host/port"))); return -1; } // Add multiple endpoints > 1 for (int i=endpointSeq.length() - 1; i > 0 ; i--) { TAO_SCIOP_Endpoint *endpoint = 0; ACE_NEW_RETURN (endpoint, TAO_SCIOP_Endpoint (endpointSeq[i], this->endpoint_.port_, this->endpoint_.priority()), -1); this->count_ += endpoint->preferred_interfaces (this->orb_core ()); this->add_endpoint (endpoint); } // SCIOR has a max_streams variable // We are ignoring it for now since ACE SCTP code fixes at 1 anyway. CORBA::UShort max_streams; if ((cdr.read_ushort(max_streams)) == 0) { 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_SCIOP_Profile::do_is_equivalent (  const TAO_Profile *  other_profile  )  [protected, virtual]

Implements TAO_Profile. Definition at line 240 of file SCIOP_Profile.cpp. References endpoint_, TAO_SCIOP_Endpoint::is_equivalent(), and TAO_SCIOP_Endpoint::next_. { const TAO_SCIOP_Profile *op = dynamic_cast<const TAO_SCIOP_Profile *> (other_profile); if (op == 0) return 0; // Check endpoints equivalence. const TAO_SCIOP_Endpoint *other_endp = &op->endpoint_; for (TAO_SCIOP_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_SCIOP_Profile::encode_endpoints (  void   )  [virtual]

Implements TAO_Profile. Definition at line 406 of file SCIOP_Profile.cpp. References TAO_SCIOP_Endpoint::host(), TAO_SCIOP_Endpoint::is_encodable_, TAO::unbounded_value_sequence< TAO_SCIOP_Endpoint_Info >::length(), TAO_SCIOP_Endpoint::next_, TAO_SCIOP_Endpoint::port(), TAO_Endpoint::priority(), TAO_Profile::set_tagged_components(), and TAO_ENCAP_BYTE_ORDER. { CORBA::ULong actual_count = 0; const TAO_SCIOP_Endpoint *endpoint = &this->endpoint_; // Count the number of endpoints that needs to be encoded for (CORBA::ULong c = 0; c != this->count_; ++c) { if (endpoint->is_encodable_) ++actual_count; endpoint = endpoint->next_; } // 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_SCIOPEndpointSequence endpoints; endpoints.length (actual_count); endpoint = &this->endpoint_; for (CORBA::ULong i = 0; i < this->count_; ++i) { if (endpoint->is_encodable_) { 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; this->set_tagged_components (out_cdr); return 0; }

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

Implements TAO_Profile. Definition at line 294 of file SCIOP_Profile.cpp. Referenced by TAO_SCIOP_Acceptor::create_new_profile(), TAO_SCIOP_Acceptor::create_shared_profile(), and ~TAO_SCIOP_Profile(). { return &this->endpoint_; }

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

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

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

Implements TAO_Profile. Definition at line 264 of file SCIOP_Profile.cpp. References TAO_SCIOP_Endpoint::hash(), TAO_Profile::hash_service_i(), TAO::unbounded_value_sequence< T >::length(), TAO_GIOP_Message_Version::minor, TAO_SCIOP_Endpoint::next_, TAO::Refcounted_ObjectKey::object_key(), and TAO_Profile::tag(). { // Get the hash value for all endpoints. CORBA::ULong hashval = 0; for (TAO_SCIOP_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; }

TAO_BEGIN_VERSIONED_NAMESPACE_DECL char TAO_SCIOP_Profile::object_key_delimiter (  void   )  const [virtual]

Implements TAO_Profile. Definition at line 27 of file SCIOP_Profile.cpp. References object_key_delimiter_. { return TAO_SCIOP_Profile::object_key_delimiter_; }

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

Implements TAO_Profile. Definition at line 140 of file SCIOP_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_SCIOP_Endpoint::host_, LM_DEBUG, MAXHOSTNAMELEN, TAO_ORB_Core::object_key_table(), TAO_Profile::orb_core(), TAO_SCIOP_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 ("SCIOP_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_SCIOP_Profile::prefix (  void   )  [static]

Return the char string prefix. Definition at line 353 of file SCIOP_Profile.cpp. { return ::prefix_; }

char * TAO_SCIOP_Profile::to_string (   )  [virtual]

Template methods. Please see Profile.h for documentation. Implements TAO_Profile. Definition at line 315 of file SCIOP_Profile.cpp. References TAO::ObjectKey::encode_sequence_to_string(), TAO::Refcounted_ObjectKey::object_key(), object_key_delimiter_, TAO_SCIOP_Endpoint::port(), prefix_, ACE_OS::sprintf(), CORBA::string_alloc(), and ACE_OS::strlen(). { 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 (::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", ::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_SCIOP_Profile::count_ [protected]

Number of endpoints in the list headed by . Definition at line 134 of file SCIOP_Profile.h.

TAO_SCIOP_Endpoint TAO_SCIOP_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 for two cases (1) when RTCORBA is enabled and (2) the ORB is initialized with -ORBPreferredInterfaces option. However, in the near future, this will be used in for mode as well, e.g., to support TAG_ALTERNATE_IIOP_ADDRESS feature. This is probably as good a place to discuss how the list of endpoints is used for #2. If the ORB is configured to use preferred interfaces for invocation, TAO creates an endpoint per preferred interface. To be clear, every tuple <destination:target> will have an endpoint. What TAO essentially does is that creates it multiple endpoints so that the invocation code path can use existing iterating techniques to try one preferred interface after another (if the first did not work). If the ORB is configured with -ORBEnforcePreferredInterface set to false in addition to the ORBPreferredInterfaces option , TAO creates another endpoint with the preferred bit set to null, so that the invocation code can fall back to a SCTP stack returned local address. Addressing info of the default endpoint, i.e., head of the list, is transmitted using standard SCIOP ProfileBody components. See method documentation above for how the rest of the endpoint list is transmitted. Definition at line 131 of file SCIOP_Profile.h. Referenced by do_is_equivalent().

const char TAO_SCIOP_Profile::object_key_delimiter_ = '/' [static]

The object key delimiter that SCIOP uses or expects. Definition at line 22 of file SCIOP_Profile.cpp. Referenced by object_key_delimiter(), and to_string().

---

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

• SCIOP_Profile.h
• SCIOP_Profile.cpp

---