Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

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:

Inheritance graph
[legend]
Collaboration diagram for TAO_IIOP_Profile:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual char object_key_delimiter (void) const
 The object key delimiter.

 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.

 ~TAO_IIOP_Profile (void)
 Destructor is to be called only through <_decr_refcnt>.

virtual char * to_string (ACE_ENV_SINGLE_ARG_DECL)
 Template methods. Please see Profile.h for documentation.

virtual int encode_endpoints (void)
virtual TAO_Endpointendpoint (void)
virtual CORBA::ULong endpoint_count (void) const
 Return how many endpoints this profile contains.

virtual CORBA::ULong hash (CORBA::ULong max ACE_ENV_ARG_DECL)
 Return a hash value for this object.

void add_endpoint (TAO_IIOP_Endpoint *endp)

Static Public Methods

const char * prefix (void)
 Return the char string prefix.


Static Public Attributes

const char object_key_delimiter_ = '/'
 The object key delimiter that IIOP uses or expects.


Protected Methods

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 ACE_ENV_ARG_DECL)
 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.


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.

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.

TAO_IIOP_Profile::TAO_IIOP_Profile TAO_ORB_Core   orb_core
 

Profile constructor, default.

TAO_IIOP_Profile::~TAO_IIOP_Profile void   
 

Destructor is to be called only through <_decr_refcnt>.


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>.

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.

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.

int TAO_IIOP_Profile::decode_profile TAO_InputCDR   cdr [protected, virtual]
 

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

Implements TAO_Profile.

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.

int TAO_IIOP_Profile::encode_endpoints void    [virtual]
 

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.

Implements TAO_Profile.

TAO_Endpoint * TAO_IIOP_Profile::endpoint void    [virtual]
 

Return 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.

CORBA::ULong TAO_IIOP_Profile::endpoint_count void    const [virtual]
 

Return how many endpoints this profile contains.

Implements TAO_Profile.

CORBA::ULong TAO_IIOP_Profile::hash CORBA::ULong max    ACE_ENV_ARG_DECL [virtual]
 

Return a hash value for this object.

Implements TAO_Profile.

char TAO_IIOP_Profile::object_key_delimiter void    const [virtual]
 

The object key delimiter.

Implements TAO_Profile.

virtual void TAO_IIOP_Profile::parse_string_i const char *string    ACE_ENV_ARG_DECL [protected, virtual]
 

Protocol specific implementation of parse_string ().

Implements TAO_Profile.

const char * TAO_IIOP_Profile::prefix void    [static]
 

Return the char string prefix.

char * TAO_IIOP_Profile::to_string ACE_ENV_SINGLE_ARG_DECL    [virtual]
 

Template methods. Please see Profile.h for documentation.

Implements TAO_Profile.


Member Data Documentation

CORBA::ULong TAO_IIOP_Profile::count_ [protected]
 

Number of endpoints in the list headed by <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 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 feature. 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.

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

The object key delimiter that IIOP uses or expects.


The documentation for this class was generated from the following files:
Generated on Wed Jan 14 23:27:04 2004 for TAO by doxygen1.2.18