TAO_SHMIOP_Profile Class Reference

This class defines the protocol specific attributes required for locating local ORBs over local IPC mechanism to use the shared memory transport. More...

#include <SHMIOP_Profile.h>

Inheritance diagram for TAO_SHMIOP_Profile:

[legend]Collaboration diagram for TAO_SHMIOP_Profile:

[legend]List of all members.

Public Member Functions
virtual char	object_key_delimiter (void) const
	TAO_SHMIOP_Profile (const ACE_MEM_Addr &addr, const TAO::ObjectKey &object_key, const TAO_GIOP_Message_Version &version, TAO_ORB_Core *orb_core)
	TAO_SHMIOP_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_SHMIOP_Profile (TAO_ORB_Core *orb_core)
	Profile constructor, default.
	~TAO_SHMIOP_Profile (void)
	Destructor is to be called only through <_decr_refcnt>.
virtual char *	to_string (void)
	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_SHMIOP_Endpoint *endp)
Static Public Member Functions
static const char *	prefix (void)
	Return the char string prefix.
Static Public Attributes
static const char	object_key_delimiter_ = '/'
	The object key delimiter that SHMIOP 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)
Private Attributes
TAO_SHMIOP_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 local ORBs over local IPC mechanism to use the shared memory transport.

This class defines the SHMIOP profile.

Definition at line 45 of file SHMIOP_Profile.h.

---

Constructor & Destructor Documentation

TAO_SHMIOP_Profile::TAO_SHMIOP_Profile	(	const ACE_MEM_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 33 of file SHMIOP_Profile.cpp.

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

TAO_SHMIOP_Profile::TAO_SHMIOP_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 47 of file SHMIOP_Profile.cpp.

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

TAO_SHMIOP_Profile::TAO_SHMIOP_Profile

(

TAO_ORB_Core *

orb_core

)

Profile constructor, default.

Definition at line 62 of file SHMIOP_Profile.cpp.

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

TAO_SHMIOP_Profile::~TAO_SHMIOP_Profile

(

void

)

Destructor is to be called only through <_decr_refcnt>.

Definition at line 71 of file SHMIOP_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_SHMIOP_Profile::add_endpoint

(

TAO_SHMIOP_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 321 of file SHMIOP_Profile.cpp.

References count_, endpoint_, and TAO_SHMIOP_Endpoint::next_.

Referenced by TAO_SHMIOP_Acceptor::create_shared_profile(), and decode_endpoints().

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

  this->count_++;
}

void TAO_SHMIOP_Profile::create_profile_body

(

TAO_OutputCDR &

cdr

)

const [protected, virtual]

Implements TAO_Profile.

Definition at line 373 of file SHMIOP_Profile.cpp.

References ACE_ERROR, TAO_Tagged_Components::encode(), LM_ERROR, TAO_Profile::ref_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_SHMIOP_Profile::decode_endpoints

(

void

)

[protected, virtual]

Implements TAO_Profile.

Definition at line 458 of file SHMIOP_Profile.cpp.

References ACE_NEW_RETURN, add_endpoint(), endpoint(), endpoint_, TAO_Endpoint::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_SHMIOP_Endpoint *endpoint = 0;
          ACE_NEW_RETURN (endpoint,
                          TAO_SHMIOP_Endpoint (endpoints[i].host,
                                               endpoints[i].port,
                                               endpoints[i].priority),
                          -1);

          this->add_endpoint (endpoint);
        }
    }

  return 0;
}

int TAO_SHMIOP_Profile::decode_profile

(

TAO_InputCDR &

cdr

)

[protected, virtual]

Template methods. Please see tao/Profile.h for documentation.

Implements TAO_Profile.

Definition at line 103 of file SHMIOP_Profile.cpp.

References ACE_DEBUG, ACE_TEXT, ACE_InputCDR::good_bit(), LM_DEBUG, ACE_InputCDR::read_string(), ACE_InputCDR::read_ushort(), and TAO_debug_level.

{
  // 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) SHMIOP_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_SHMIOP_Profile::do_is_equivalent

(

const TAO_Profile *

other_profile

)

[protected, virtual]

Implements TAO_Profile.

Definition at line 267 of file SHMIOP_Profile.cpp.

References endpoint_, and TAO_SHMIOP_Endpoint::next_.

{
  const TAO_SHMIOP_Profile *op =
    dynamic_cast <const TAO_SHMIOP_Profile *> (other_profile);

  if (op == 0)
    return 0;

  // Check endpoints equivalence.
  const TAO_SHMIOP_Endpoint *other_endp = &op->endpoint_;
  for (TAO_SHMIOP_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_SHMIOP_Profile::encode_endpoints

(

void

)

[virtual]

Implements TAO_Profile.

Definition at line 403 of file SHMIOP_Profile.cpp.

References ACE_OutputCDR::begin(), ACE_Message_Block::cont(), count_, endpoint(), endpoint_, ACE_OS::memcpy(), TAO_Endpoint::priority(), TAO_Tagged_Components::set_component(), TAO_Profile::tagged_components_, TAO_ENCAP_BYTE_ORDER, TAO_TAG_ENDPOINTS, 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_);

  TAO_SHMIOP_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_SHMIOP_Profile::endpoint

(

void

)

[virtual]

Implements TAO_Profile.

Definition at line 87 of file SHMIOP_Profile.cpp.

References endpoint_.

Referenced by TAO_SHMIOP_Acceptor::create_new_profile(), decode_endpoints(), and encode_endpoints().

{
  return &this->endpoint_;
}

CORBA::ULong TAO_SHMIOP_Profile::endpoint_count

(

void

)

const [virtual]

Implements TAO_Profile.

Definition at line 93 of file SHMIOP_Profile.cpp.

References count_.

{
  return this->count_;
}

CORBA::ULong TAO_SHMIOP_Profile::hash

(

CORBA::ULong

max

)

[virtual]

Implements TAO_Profile.

Definition at line 291 of file SHMIOP_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 hashvalue for all endpoints.
  CORBA::ULong hashval = 0;
  for (TAO_SHMIOP_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_SHMIOP_Profile::object_key_delimiter

(

void

)

const [virtual]

Implements TAO_Profile.

Definition at line 28 of file SHMIOP_Profile.cpp.

{
  return TAO_SHMIOP_Profile::object_key_delimiter_;
}

void TAO_SHMIOP_Profile::parse_string_i

(

const char *

string

)

[protected, virtual]

Implements TAO_Profile.

Definition at line 130 of file SHMIOP_Profile.cpp.

References CORBA::SystemException::_tao_minor_code(), ACE_DEBUG, ACE_TEXT, ACE_OS::atoi(), CORBA::COMPLETED_NO, endpoint_, ACE_INET_Addr::get_host_addr(), ACE_INET_Addr::get_host_name(), ACE_INET_Addr::get_port_number(), TAO_SHMIOP_Endpoint::host_, LM_DEBUG, MAXHOSTNAMELEN, TAO_SHMIOP_Endpoint::port_, ACE_OS::strchr(), ACE_OS::strcmp(), CORBA::string_alloc(), ACE_INET_Addr::string_to_addr(), ACE_OS::strncpy(), ACE_OS::strspn(), TAO_debug_level, and TAO::VMCID.

{
  // Pull off the "hostname:port/" part of the objref
  // Copy the string because we are going to modify it...
  CORBA::String_var copy (string);

  char *start = copy.inout ();
  char *cp = ACE_OS::strchr (start, ':');  // Look for a port

  if (cp == 0)
    {
      // No host/port delimiter!
      throw ::CORBA::INV_OBJREF (
                   CORBA::SystemException::_tao_minor_code (
                     TAO::VMCID,
                     EINVAL),
                   CORBA::COMPLETED_NO);
    }

  char *okd = ACE_OS::strchr (start, this->object_key_delimiter_);

  if (okd == 0)
    {
      // No object key delimiter!
      throw ::CORBA::INV_OBJREF (
                   CORBA::SystemException::_tao_minor_code (
                     TAO::VMCID,
                     EINVAL),
                   CORBA::COMPLETED_NO);
    }

  // Don't increment the pointer 'cp' directly since we still need
  // to use it immediately after this block.

  CORBA::ULong length = okd - (cp + 1);
  // Don't allocate space for the colon ':'.

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

  ACE_OS::strncpy (tmp.inout (), cp + 1, length);
  tmp[length] = '\0';

  if (ACE_OS::strspn (tmp.in (), "1234567890") == length)
    {
      this->endpoint_.port_ =
        static_cast <CORBA::UShort> (ACE_OS::atoi (tmp.in ()));
    }
  else
    {
      ACE_INET_Addr ia;
      if (ia.string_to_addr (tmp.in ()) == -1)
        {
          throw ::CORBA::INV_OBJREF (
              CORBA::SystemException::_tao_minor_code (
                  TAO::VMCID,
                  EINVAL),
              CORBA::COMPLETED_NO);
        }
      else
        {
          this->endpoint_.port_ = ia.get_port_number ();
        }
    }

  length = cp - start;

  tmp = CORBA::string_alloc (length);

  ACE_OS::strncpy (tmp.inout (), start, length);
  tmp[length] = '\0';

  this->endpoint_.host_ = tmp._retn ();

  ACE_INET_Addr host_addr;

  if (ACE_OS::strcmp (this->endpoint_.host_.in (), "") == 0)
    {
      char tmp_host [MAXHOSTNAMELEN + 1];

      // If no host is specified: assign the default host : the local host.
      if (host_addr.get_host_name (tmp_host,
                                   sizeof (tmp_host)) != 0)
      {
        const char *tmp = host_addr.get_host_addr ();
        if (tmp == 0)
          {
            if (TAO_debug_level > 0)
              ACE_DEBUG ((LM_DEBUG,
                          ACE_TEXT ("\n\nTAO (%P|%t) ")
                          ACE_TEXT ("SHMIOP_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 (
                           TAO::VMCID,
                           EINVAL),
                         CORBA::COMPLETED_NO);
          }
        else
          this->endpoint_.host_ = tmp;
      }
      else
        {
          this->endpoint_.host_ = (const char *) tmp_host;
        }
    }

  if (this->endpoint_.object_addr_.set (this->endpoint_.port_,
                                        this->endpoint_.host_.in ()) == -1)
    {
      if (TAO_debug_level > 0)
        {
          ACE_DEBUG ((LM_DEBUG,
                      ACE_TEXT ("TAO (%P|%t) SHMIOP_Profile::parse_string () - \n")
                      ACE_TEXT ("TAO (%P|%t) ACE_INET_Addr::set () failed")));
        }

      // @@ What's the right exception to throw here?
      throw ::CORBA::INV_OBJREF (
                   CORBA::SystemException::_tao_minor_code (
                     TAO::VMCID,
                     EINVAL),
                   CORBA::COMPLETED_NO);
    }

  TAO::ObjectKey ok;
  TAO::ObjectKey::decode_string_to_sequence (ok,
                                             okd + 1);  // increment past the object key separator

  (void) this->orb_core ()->object_key_table ().bind (ok,
                                                      this->ref_object_key_);
}

const char * TAO_SHMIOP_Profile::prefix

(

void

)

[static]

Return the char string prefix.

Definition at line 367 of file SHMIOP_Profile.cpp.

References prefix_.

{
  return ::prefix_;
}

char * TAO_SHMIOP_Profile::to_string

(

void

)

[virtual]

Template methods, please see Profile.h for documentation.

Implements TAO_Profile.

Definition at line 330 of file SHMIOP_Profile.cpp.

References endpoint_, object_key_delimiter_, TAO_SHMIOP_Endpoint::port(), TAO_Profile::ref_object_key_, 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_SHMIOP_Profile::count_ [private]

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

Definition at line 122 of file SHMIOP_Profile.h.

Referenced by add_endpoint(), encode_endpoints(), and endpoint_count().

TAO_SHMIOP_Endpoint TAO_SHMIOP_Profile::endpoint_ [private]

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_IIOP_ADDRESS-style feature. Addressing info of the default endpoint, i.e., head of the list, is transmitted using standard SHMIOP ProfileBody components. See <encode_endpoints> method documentation above for how the rest of the endpoint list is transmitted.

Definition at line 119 of file SHMIOP_Profile.h.

Referenced by add_endpoint(), decode_endpoints(), do_is_equivalent(), encode_endpoints(), endpoint(), parse_string_i(), and to_string().

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

The object key delimiter that SHMIOP uses or expects.

Definition at line 49 of file SHMIOP_Profile.h.

Referenced by TAO_SHMIOP_Connector::object_key_delimiter(), and to_string().

---

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

• SHMIOP_Profile.h
• SHMIOP_Profile.cpp

---