TAO_IIOP_Profile Class Reference

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

#include <IIOP_Profile.h>

Inheritance diagram for TAO_IIOP_Profile:

[legend]Collaboration diagram for TAO_IIOP_Profile:

[legend]List of all members.

Public Member Functions
	TAO_IIOP_Profile (const ACE_INET_Addr &addr, const TAO::ObjectKey &object_key, const TAO_GIOP_Message_Version &version, TAO_ORB_Core *orb_core)
	TAO_IIOP_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_IIOP_Profile (TAO_ORB_Core *orb_core)
	Profile constructor, default.
void	add_endpoint (TAO_IIOP_Endpoint *endp)
void	remove_endpoint (TAO_IIOP_Endpoint *endp)
virtual void	remove_generic_endpoint (TAO_Endpoint *ep)
virtual void	add_generic_endpoint (TAO_Endpoint *ep)
	Add an endpoint when the specific endpoint type is unknown.
virtual char	object_key_delimiter (void) const
	The object key delimiter that IIOP uses or expects.
virtual char *	to_string (void)
	Template methods. Please see Profile.h for documentation.
virtual int	encode_endpoints (void)
virtual int	encode_alternate_endpoints (void)
virtual TAO_Endpoint *	endpoint (void)
virtual TAO_Endpoint *	base_endpoint (void)
virtual CORBA::ULong	endpoint_count (void) const
	Return how many endpoints this profile contains.
virtual CORBA::ULong	hash (CORBA::ULong max)
	Return a hash value for this object.
Static Public Member Functions
static const char *	prefix (void)
	Return the char string prefix.
Static Public Attributes
static const char	object_key_delimiter_ = '/'
Protected Member Functions
	~TAO_IIOP_Profile (void)
	Destructor is to be called only through <_decr_refcnt>.
int	encode_endpoints_for_rt (void)
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)
	Protocol specific implementation of parse_string ().
virtual void	create_profile_body (TAO_OutputCDR &cdr) const
	Creates an encapsulation of the ProfileBody struct in the cdr.
virtual CORBA::Boolean	do_is_equivalent (const TAO_Profile *other_profile)
	Profile equivalence template method invoked on subclasses.
Protected Attributes
TAO_IIOP_Endpoint	endpoint_
CORBA::ULong	count_
	Number of endpoints in the list headed by <endpoint_>.

---

Detailed Description

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

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

Definition at line 44 of file IIOP_Profile.h.

---

Constructor & Destructor Documentation

TAO_IIOP_Profile::TAO_IIOP_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 51 of file IIOP_Profile.cpp.

  : TAO_Profile (IOP::TAG_INTERNET_IOP,
                 orb_core,
                 object_key,
                 version),
    endpoint_ (addr,
               orb_core->orb_params ()->use_dotted_decimal_addresses ()),
    count_ (1)
{
}

TAO_IIOP_Profile::TAO_IIOP_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 65 of file IIOP_Profile.cpp.

  : TAO_Profile (IOP::TAG_INTERNET_IOP,
                 orb_core,
                 object_key,
                 version),
    endpoint_ (host, port, addr),
    count_ (1)
{
}

TAO_IIOP_Profile::TAO_IIOP_Profile

(

TAO_ORB_Core *

orb_core

)

Profile constructor, default.

Definition at line 80 of file IIOP_Profile.cpp.

  : TAO_Profile (IOP::TAG_INTERNET_IOP,
                 orb_core,
                 TAO_GIOP_Message_Version (TAO_DEF_GIOP_MAJOR,
                                           TAO_DEF_GIOP_MINOR)),
    endpoint_ (),
    count_ (1)
{
}

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_IIOP_Profile::~TAO_IIOP_Profile

(

void

)

[protected]

Destructor is to be called only through <_decr_refcnt>.

Definition at line 24 of file IIOP_Profile.cpp.

References 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_IIOP_Profile::add_endpoint

(

TAO_IIOP_Endpoint *

endp

)

Add endp to this profile's list of endpoints (it is inserted next to the head of the list). This profiles takes ownership of endp.

Definition at line 395 of file IIOP_Profile.cpp.

References count_, endpoint_, and TAO_IIOP_Endpoint::next_.

Referenced by add_generic_endpoint(), TAO_IIOP_Acceptor::create_shared_profile(), and decode_endpoints().

{
  endp->next_ = this->endpoint_.next_;
  this->endpoint_.next_ = endp;

  ++this->count_;
}

void TAO_IIOP_Profile::add_generic_endpoint

(

TAO_Endpoint *

ep

)

[virtual]

Add an endpoint when the specific endpoint type is unknown.

Reimplemented from TAO_Profile.

Definition at line 451 of file IIOP_Profile.cpp.

References ACE_NEW, and add_endpoint().

{
  TAO_IIOP_Endpoint *iep = dynamic_cast<TAO_IIOP_Endpoint *>(endp);
  if (iep != 0)
    {
      TAO_IIOP_Endpoint *clone;
      ACE_NEW (clone, TAO_IIOP_Endpoint(*iep));
      this->add_endpoint(clone);
    }
}

TAO_Endpoint * TAO_IIOP_Profile::base_endpoint

(

void

)

[virtual]

Since SSLIOP_Profile derives from IIOP_Profile, but SSLIOP_Endpoint does not derive from IIOP_Endpoint, it is necessary to have a way of always getting the IIOP_Endpoint using a generic interface regardless of the final type of the profile.

Reimplemented from TAO_Profile.

Definition at line 381 of file IIOP_Profile.cpp.

References endpoint_.

{
  // do not call endpoint(), return the value directly. This is to
  // avoid calling a derived implementation of endpoint().
  return &this->endpoint_;
}

void TAO_IIOP_Profile::create_profile_body

(

TAO_OutputCDR &

cdr

)

const [protected, virtual]

Creates an encapsulation of the ProfileBody struct in the cdr.

Implements TAO_Profile.

Definition at line 555 of file IIOP_Profile.cpp.

References ACE_ERROR, TAO_Tagged_Components::encode(), LM_ERROR, TAO_Profile::ref_object_key_, ACE_OS::strchr(), 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
#if defined (ACE_HAS_IPV6)
  // For IPv6 decimal addresses make sure the possibly included scopeid
  // is not published as this has only local meaning.
  const char* host = 0;
  const char* pos = 0;
  if (this->endpoint_.is_ipv6_decimal_ &&
      (pos = ACE_OS::strchr (host = this->endpoint_.host (), '%')) != 0)
    {
      ACE_CString tmp;
      size_t len = pos - host;
      tmp.set (this->endpoint_.host (), len, 1);
      encap.write_string (tmp.c_str ());
    }
  else
#endif /* ACE_HAS_IPV6 */
  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 - IIOP_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_IIOP_Profile::decode_endpoints

(

void

)

[protected, virtual]

Helper for decode(). Decodes endpoints from a tagged component. Decode only if RTCORBA is enabled. Furthermore, we may not find TAO_TAG_ENDPOINTS component, e.g., if we are talking to nonRT version of TAO or some other ORB. This is not an error, and we must proceed. Return 0 on success and -1 on failure.

Implements TAO_Profile.

Definition at line 747 of file IIOP_Profile.cpp.

References ACE_NEW_RETURN, add_endpoint(), TAO_Tagged_Components::components(), endpoint(), endpoint_, TAO_Endpoint::priority(), TAO_Profile::tag(), TAO_Profile::tagged_components_, TAO_INVALID_PRIORITY, and TAO_TAG_ENDPOINTS.

{
  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_IIOP_Endpoint *endpoint = 0;
          ACE_NEW_RETURN (endpoint,
                          TAO_IIOP_Endpoint (endpoints[i].host,
                                             endpoints[i].port,
                                             endpoints[i].priority),
                          -1);

          this->add_endpoint (endpoint);
        }
    }

  // Now decode if there are any TAG_ALTERNATE_IIOP_ADDRESS
  // components.

  IOP::MultipleComponentProfile& tc = this->tagged_components_.components();
  for (CORBA::ULong index = 0; index < tc.length(); index++)
    {
      if (tc[index].tag != IOP::TAG_ALTERNATE_IIOP_ADDRESS)
        continue;
      const CORBA::Octet *buf =
        tc[index].component_data.get_buffer ();

      TAO_InputCDR in_cdr (reinterpret_cast<const char*>(buf),
                           tc[index].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));

      CORBA::String_var host;
      CORBA::Short port;

      if ((in_cdr >> host.out()) == 0 ||
          (in_cdr >> port) == 0)
        return -1;

      TAO_IIOP_Endpoint *endpoint = 0;
      ACE_NEW_RETURN (endpoint,
                      TAO_IIOP_Endpoint (host.in(),
                                         port,
                                         TAO_INVALID_PRIORITY),
                      -1);

      this->add_endpoint (endpoint);
    }

  return 0;
}

int TAO_IIOP_Profile::decode_profile

(

TAO_InputCDR &

cdr

)

[protected, virtual]

Template methods. Please see Profile.h for the documentation.

Implements TAO_Profile.

Definition at line 92 of file IIOP_Profile.cpp.

References ACE_DEBUG, ACE_TEXT, count_, endpoint_, TAO_ORB_Parameters::enforce_pref_interfaces(), ACE_InputCDR::good_bit(), TAO_IIOP_Endpoint::host(), LM_DEBUG, TAO_Profile::orb_core(), TAO_ORB_Core::orb_params(), TAO_IIOP_Endpoint::port(), TAO_IIOP_Endpoint::preferred_interfaces(), TAO_ORB_Parameters::preferred_interfaces(), ACE_InputCDR::read_string(), ACE_InputCDR::read_ushort(), and TAO_debug_level.

{
  // Decode host and port into the <endpoint_>.
  // it is necessary to do it indirectly so that IPv6 host addresses
  // can be evaluated correctly.
  CORBA::String_var host;
  CORBA::UShort port;

  if (cdr.read_string(host.out()) == 0 ||
      cdr.read_ushort (port) == 0)
    {
      if (TAO_debug_level > 0)
        ACE_DEBUG ((LM_DEBUG,
                    ACE_TEXT ("TAO (%P|%t) IIOP_Profile::decode - ")
                    ACE_TEXT ("error while decoding host/port\n")));
      return -1;
    }

  this->endpoint_.host(host.in());
  this->endpoint_.port(port);

  if (cdr.good_bit ())
    {
      // Invalidate the object_addr_ until first access.
      this->endpoint_.object_addr_.set_type (-1);

      const char* csv = this->orb_core()->orb_params()->preferred_interfaces();
      bool const enforce =
        this->orb_core()->orb_params()->enforce_pref_interfaces();
      this->count_ += this->endpoint_.preferred_interfaces(csv, enforce);

      return 1;
    }

  return -1;
}

CORBA::Boolean TAO_IIOP_Profile::do_is_equivalent

(

const TAO_Profile *

other_profile

)

[protected, virtual]

Profile equivalence template method invoked on subclasses.

TAO_Profile subclasses must implement this template method so that they can apply their own definition of profile equivalence.

Implements TAO_Profile.

Definition at line 314 of file IIOP_Profile.cpp.

References count_, endpoint_, and TAO_IIOP_Endpoint::next_.

{
  if (other_profile == this)
    return true;

  const TAO_IIOP_Profile *op =
    dynamic_cast<const TAO_IIOP_Profile *> (other_profile);

  // Make sure we have a TAO_IIOP_Profile.
  if (op == 0)
    return false;

  if (this->count_ == 0 && op->count_ == 0)
    return true;
  if (this->count_ != op->count_)
    return false;
  // Check endpoints equivalence.
  const TAO_IIOP_Endpoint *other_endp = &op->endpoint_;
  for (TAO_IIOP_Endpoint *endp = &this->endpoint_;
       endp != 0;
       endp = endp->next_)
    {
      if (endp->is_equivalent (other_endp))
        other_endp = other_endp->next_;
      else
        return false;
    }

  return true;
}

int TAO_IIOP_Profile::encode_alternate_endpoints

(

void

)

[virtual]

Encode alternate endpoints for non-RT profiles, using multiple TAG_ALTERNATE_IIOP_ADDRESS components, one endpoint per component

Reimplemented from TAO_Profile.

Definition at line 601 of file IIOP_Profile.cpp.

References count_, endpoint(), endpoint_, ACE_OS::memcpy(), TAO_Tagged_Components::set_component(), ACE_OS::strchr(), TAO_Endpoint::tag(), TAO_Profile::tagged_components_, and TAO_ENCAP_BYTE_ORDER.

{
  // encode IOP::TAG_ALTERNATE_IIOP_ADDRESS tags if there are more
  // than one endpoints to listen to.
  const TAO_IIOP_Endpoint *endpoint = &this->endpoint_;
  for (CORBA::ULong i = 1;
       i < this->count_;
       ++i)
    {
      // The first endpoint is the actual endpoint. The rest of the
      // endpoints are the alternate endpoints. So, neglect the first
      // endpoint for TAG_ALTERNATE_IIOP_ADDRESS
      endpoint = endpoint->next_;

      if (!endpoint->is_encodable_)
        continue;

      // Encode the data structure. - The CORBA specification does not
      // mandate a particular container for the endpoints, only that
      // it is encoded as host first, then port.
      TAO_OutputCDR out_cdr;

#if defined (ACE_HAS_IPV6)
      // For IPv6 decimal addresses make sure the possibly included scopeid
      // is not published as this has only local meaning.
      const char* host = 0;
      const char* pos = 0;
      if (endpoint->is_ipv6_decimal_ &&
          (pos = ACE_OS::strchr (host = endpoint->host (), '%')) != 0)
        {
          ACE_CString tmp;
          size_t len = pos - host;
          tmp.set (endpoint->host (), len, 1);
          if ((out_cdr << ACE_OutputCDR::from_boolean (TAO_ENCAP_BYTE_ORDER) == 0)
              || (out_cdr << tmp.c_str () == 0)
              || (out_cdr << endpoint->port () == 0))
            return -1;
          out_cdr.write_string (len, endpoint->host ());
        }
      else
#endif /* ACE_HAS_IPV6 */
      if ((out_cdr << ACE_OutputCDR::from_boolean (TAO_ENCAP_BYTE_ORDER) == 0)
                || (out_cdr << endpoint->host () == 0)
          || (out_cdr << endpoint->port () == 0))
        return -1;

      IOP::TaggedComponent tagged_component;
      tagged_component.tag = IOP::TAG_ALTERNATE_IIOP_ADDRESS;

      size_t length = out_cdr.total_length ();
      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;
}

int TAO_IIOP_Profile::encode_endpoints

(

void

)

[virtual]

Encode endpoints for RT profiles, using a single TAO_TAG_ENDPOINT component.

Implements TAO_Profile.

Definition at line 674 of file IIOP_Profile.cpp.

References count_, endpoint(), endpoint_, ACE_String_Base_Const::npos, and TAO_Endpoint::priority().

{
  CORBA::ULong actual_count = 0;

  const TAO_IIOP_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::IIOPEndpointSequence endpoints;
  endpoints.length (actual_count);

  endpoint = &this->endpoint_;

  for (CORBA::ULong i = 0;
       i < actual_count;
       ++i)
    {
      if (endpoint->is_encodable_)
        {
#if defined (ACE_HAS_IPV6)
          if (endpoint->is_ipv6_decimal_)
            {
              // Don't publish scopeid if included.
              ACE_CString tmp(endpoint->host ());
              ACE_CString::size_type pos = tmp.find('%');
              if (pos != ACE_CString::npos)
                {
                  tmp = tmp.substr (0, pos + 1);
                  tmp[pos] = '\0';
                  endpoints[i].host = tmp.c_str();
                }
              else
                endpoints[i].host = tmp.c_str();
            }
          else
#endif /* ACE_HAS_IPV6 */
          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;
}

int TAO_IIOP_Profile::encode_endpoints_for_rt

(

void

)

[protected]

Helper method for encode_endpoints to deal with RT requests.

Encodes this profile's endpoints into a tagged component. This is done only if RTCORBA is enabled, since currently this is the only case when we have more than one endpoint per profile. Returns 0 on success and -1 on failure.

Endpoints are transmitted using TAO-proprietory tagged component. Component tag is TAO_TAG_ENDPOINTS and component data is an encapsulation of a sequence of structs, each representing a single endpoint. Data format is specified in iiop_endpoins.pidl.

TAO_Endpoint * TAO_IIOP_Profile::endpoint

(

void

)

[virtual]

Return a pointer to this profile's endpoint. If the profile contains more than one endpoint, i.e., a list, the method returns the head of the list.

Implements TAO_Profile.

Definition at line 375 of file IIOP_Profile.cpp.

References endpoint_.

Referenced by TAO_IIOP_Acceptor::create_new_profile(), TAO_IIOP_Acceptor::create_shared_profile(), decode_endpoints(), encode_alternate_endpoints(), and encode_endpoints().

{
  return &this->endpoint_;
}

CORBA::ULong TAO_IIOP_Profile::endpoint_count

(

void

)

const [virtual]

Return how many endpoints this profile contains.

Implements TAO_Profile.

Definition at line 389 of file IIOP_Profile.cpp.

References count_.

{
  return this->count_;
}

CORBA::ULong TAO_IIOP_Profile::hash

(

CORBA::ULong

max

)

[virtual]

Return a hash value for this object.

Implements TAO_Profile.

Definition at line 346 of file IIOP_Profile.cpp.

References TAO_Profile::hash_service_i(), TAO_GIOP_Message_Version::minor, TAO_Profile::ref_object_key_, TAO_Profile::tag(), and TAO_Profile::version_.

{
  // Get the hash value for all endpoints.
  CORBA::ULong hashval = 0;
  for (TAO_IIOP_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 += TAO_Profile::hash_service_i (max);

  return hashval % max;
}

char TAO_IIOP_Profile::object_key_delimiter

(

void

)

const [virtual]

The object key delimiter that IIOP uses or expects.

Implements TAO_Profile.

Definition at line 44 of file IIOP_Profile.cpp.

{
  return TAO_IIOP_Profile::object_key_delimiter_;
}

void TAO_IIOP_Profile::parse_string_i

(

const char *

string

)

[protected, virtual]

Protocol specific implementation of parse_string ().

Implements TAO_Profile.

Definition at line 130 of file IIOP_Profile.cpp.

References CORBA::SystemException::_tao_minor_code(), ACE_DEBUG, ACE_ERROR, ACE_TEXT, ACE_OS::atoi(), CORBA::COMPLETED_NO, endpoint_, ACE_INET_Addr::get_host_name(), ACE_INET_Addr::get_port_number(), TAO_IIOP_Endpoint::host_, LM_DEBUG, LM_ERROR, MAXHOSTNAMELEN, TAO_GIOP_Message_Version::minor, TAO_IIOP_Endpoint::port_, ACE_OS::strchr(), ACE_OS::strcmp(), CORBA::string_alloc(), CORBA::string_dup(), ACE_INET_Addr::string_to_addr(), ACE_OS::strncpy(), ACE_OS::strspn(), TAO_debug_level, and TAO_Profile::version().

{
  // 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.
      throw ::CORBA::INV_OBJREF (
                   CORBA::SystemException::_tao_minor_code (
                     0,
                     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 defined (ACE_HAS_IPV6)
  // IPv6 numeric address in host string?
  bool ipv6_in_host = false;

  // Check if this is a (possibly) IPv6 supporting profile containing a
  // decimal IPv6 address representation.
  if ((this->version().major > TAO_MIN_IPV6_IIOP_MAJOR ||
        this->version().minor >= TAO_MIN_IPV6_IIOP_MINOR) &&
      ior[0] == '[')
    {
      // In this case we have to find the end of the numeric address and
      // start looking for the port separator from there.
      const char *cp_pos_a = ACE_OS::strchr(ior, ']');
      if (cp_pos_a == 0)
        {
          // No valid IPv6 address specified.
          if (TAO_debug_level > 0)
            {
              ACE_ERROR ((LM_ERROR,
                       ACE_TEXT ("\nTAO (%P|%t) IIOP_Profile: ")
                       ACE_TEXT ("Invalid IPv6 decimal address specified.\n")));
            }

          throw ::CORBA::INV_OBJREF (
                       CORBA::SystemException::_tao_minor_code (
                         0,
                         EINVAL),
                       CORBA::COMPLETED_NO);
        }
      else
        {
          if (cp_pos_a[1] == ':')    // Look for a port
            cp_pos = cp_pos_a + 1;
          else
            cp_pos = 0;
          ipv6_in_host = true; // host string contains full IPv6 numeric address
        }
    }
#endif /* ACE_HAS_IPV6 */

  if (cp_pos == ior)
    {
      // No hostname, however one is required by the spec when specifying a port.
      // See formal-04-03-01, section 13.6.10.3
      if (TAO_debug_level > 0)
        {
          ACE_ERROR ((LM_ERROR,
                   ACE_TEXT ("\nTAO (%P|%t) IIOP_Profile: ")
                   ACE_TEXT ("Host address may be omited only when no port has been specified.\n")));
        }

      throw ::CORBA::INV_OBJREF (
                   CORBA::SystemException::_tao_minor_code (
                     0,
                     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);

      if (tmp.in() != 0)
        {
          ACE_OS::strncpy (tmp.inout (), cp_pos + 1, length_port);
          tmp[length_port] = '\0';
        }

      if (length_port == 0)
        {
          this->endpoint_.port_ = 2809; // default IIOP port for
          // parsing corbaloc strings
        }
      else if (tmp.in () != 0 && ACE_OS::strspn (tmp.in (), "1234567890") == length_port)
        {
          this->endpoint_.port_ =
            static_cast<CORBA::UShort> (ACE_OS::atoi (tmp.in ()));
        }
      else
        {
          ACE_INET_Addr ia;
          if (tmp.in () == 0 || ia.string_to_addr (tmp.in ()) == -1)
            {
              throw ::CORBA::INV_OBJREF (
                             CORBA::SystemException::_tao_minor_code (
                               0,
                               EINVAL),
                             CORBA::COMPLETED_NO);
            }
          else
            {
              this->endpoint_.port_ = ia.get_port_number ();
            }
        }
      length_host = cp_pos - ior;
    }
  else
    length_host = okd - ior;

#if defined (ACE_HAS_IPV6)
  if (ipv6_in_host)
    length_host -= 2; // don't store '[' and ']'
#endif /* ACE_HAS_IPV6 */

  CORBA::String_var tmp = CORBA::string_alloc (length_host);

#if defined (ACE_HAS_IPV6)
  if (ipv6_in_host)
    ACE_OS::strncpy (tmp.inout (), ior + 1, length_host);
  else
#endif /* ACE_HAS_IPV6 */
  // Skip the trailing '/'
  ACE_OS::strncpy (tmp.inout (), ior, length_host);
  tmp[length_host] = '\0';

  this->endpoint_.host_ = tmp._retn ();
#if defined (ACE_HAS_IPV6)
  this->endpoint_.is_ipv6_decimal_ = ipv6_in_host;
#endif /* ACE_HAS_IPV6 */

  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?
          throw ::CORBA::INV_OBJREF (
                       CORBA::SystemException::_tao_minor_code (
                         0,
                         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_IIOP_Profile::prefix

(

void

)

[static]

Return the char string prefix.

Definition at line 549 of file IIOP_Profile.cpp.

References the_prefix.

{
  return ::the_prefix;
}

void TAO_IIOP_Profile::remove_endpoint

(

TAO_IIOP_Endpoint *

endp

)

Remove endp from this profile's list of endpoints and free the endp memory. This method assumes endp is in this profile's endpoint list.

Definition at line 404 of file IIOP_Profile.cpp.

References count_, endpoint_, and TAO_IIOP_Endpoint::next_.

Referenced by remove_generic_endpoint().

{
  if (endp == 0)
    return;

  // special handling for the target matching the base endpoint
  if (endp == &this->endpoint_)
    {
      if (--this->count_ > 0)
        {
          TAO_IIOP_Endpoint* n = this->endpoint_.next_;
          this->endpoint_ = *n;
          // since the assignment operator does not copy the next_
          // pointer, we must do it by hand
          this->endpoint_.next_ = n->next_;
          delete n;
        }
      return;
    }

  TAO_IIOP_Endpoint* last = &this->endpoint_;
  TAO_IIOP_Endpoint* cur = this->endpoint_.next_;

  while (cur != 0)
  {
    if (cur == endp)
      break;
    last = cur;
    cur = cur->next_;
  }

  if (cur != 0)
  {
    last->next_ = cur->next_;
    cur->next_ = 0;
    --this->count_;
    delete cur;
  }
}

void TAO_IIOP_Profile::remove_generic_endpoint

(

TAO_Endpoint *

ep

)

[virtual]

Remove the provided endpoint from the profile. Some subclasses of TAO_Profile already have a protocol-specific version of remove_endpoint, but this generic interface is required. The default implementation is a no-op. Protocol maintainers wishing to add support for the EndpointPolicy must implement remove_generic_endpoint to call their protocol-specific version of remove_endpoint

Reimplemented from TAO_Profile.

Definition at line 445 of file IIOP_Profile.cpp.

References remove_endpoint().

{
  this->remove_endpoint(dynamic_cast<TAO_IIOP_Endpoint *>(ep));
}

char * TAO_IIOP_Profile::to_string

(

void

)

[virtual]

Template methods. Please see Profile.h for documentation.

Implements TAO_Profile.

Definition at line 463 of file IIOP_Profile.cpp.

References TAO_IIOP_Endpoint::host(), TAO_IIOP_Endpoint::next_, ACE_String_Base_Const::npos, TAO_IIOP_Endpoint::port(), TAO_Profile::ref_object_key_, ACE_OS::sprintf(), ACE_OS::strcat(), ACE_OS::strcpy(), CORBA::string_alloc(), and ACE_OS::strlen().

{
  // corbaloc:iiop:1.2@host:port,iiop:1.2@host:port,.../key

  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 */ +
       1 /* object key separator */ +
       ACE_OS::strlen (key.in ()));
  size_t const pfx_len = (
       ACE_OS::strlen (::the_prefix) /* "iiop" */ +
       1 /* colon separator */);

 const TAO_IIOP_Endpoint *endp = 0;
 for (endp = &this->endpoint_; endp != 0; endp = endp->next_)
   {
      buflen += (
          pfx_len +
          1 /* major version */ +
          1 /* decimal point */ +
          1 /* minor version */ +
          1 /* `@' character */ +
          ACE_OS::strlen (endp->host ()) +
          1 /* colon separator */ +
          5 /* port number */ +
          1 /* comma */);
#if defined (ACE_HAS_IPV6)
      if (endp->is_ipv6_decimal_)
        buflen += 2; // room for '[' and ']'
#endif /* ACE_HAS_IPV6 */
   }

  static const char digits [] = "0123456789";

  char * buf = CORBA::string_alloc (static_cast<CORBA::ULong> (buflen));

  ACE_OS::strcpy(buf, "corbaloc:");

  for (endp = &this->endpoint_; endp != 0; endp = endp->next_)
    {
      if(&this->endpoint_ != endp)
      ACE_OS::strcat(buf, ",");

#if defined (ACE_HAS_IPV6)
      if (endp->is_ipv6_decimal_)
        {
          // Don't publish scopeid if included.
          ACE_CString tmp(endp->host ());
          ACE_CString::size_type pos = tmp.find('%');
          if (pos != ACE_CString::npos)
            {
              tmp = tmp.substr(0, pos + 1);
              tmp[pos] = '\0';
            }
          ACE_OS::sprintf (buf + ACE_OS::strlen(buf),
                  "%s:%c.%c@[%s]:%d",
                  ::the_prefix,
                  digits [this->version_.major],
                  digits [this->version_.minor],
                  tmp.c_str (),
                  endp->port () );
        }
      else
#endif
      ACE_OS::sprintf (buf + ACE_OS::strlen(buf),
              "%s:%c.%c@%s:%d",
              ::the_prefix,
              digits [this->version_.major],
              digits [this->version_.minor],
              endp->host (),
              endp->port () );

  }
  ACE_OS::sprintf (buf + ACE_OS::strlen(buf),
          "%c%s",
          this->object_key_delimiter_,
          key.in ());

  return buf;
}

---

Member Data Documentation

CORBA::ULong TAO_IIOP_Profile::count_ [protected]

Number of endpoints in the list headed by <endpoint_>.

Definition at line 188 of file IIOP_Profile.h.

Referenced by add_endpoint(), decode_profile(), do_is_equivalent(), encode_alternate_endpoints(), encode_endpoints(), endpoint_count(), and remove_endpoint().

TAO_IIOP_Endpoint TAO_IIOP_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 TCP stack returned local address. Addressing info of the default endpoint, i.e., head of the list, is transmitted using standard IIOP ProfileBody components. See <encode_endpoints> method documentation above for how the rest of the endpoint list is transmitted.

Definition at line 185 of file IIOP_Profile.h.

Referenced by add_endpoint(), base_endpoint(), decode_endpoints(), decode_profile(), do_is_equivalent(), encode_alternate_endpoints(), encode_endpoints(), endpoint(), parse_string_i(), and remove_endpoint().

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

Definition at line 49 of file IIOP_Profile.h.

Referenced by TAO_IIOP_Connector::object_key_delimiter().

---

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

• IIOP_Profile.h
• IIOP_Profile.cpp

---