diff options
Diffstat (limited to 'TAO/orbsvcs/orbsvcs/PortableGroup/UIPMC_Profile.h')
-rw-r--r-- | TAO/orbsvcs/orbsvcs/PortableGroup/UIPMC_Profile.h | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/TAO/orbsvcs/orbsvcs/PortableGroup/UIPMC_Profile.h b/TAO/orbsvcs/orbsvcs/PortableGroup/UIPMC_Profile.h new file mode 100644 index 00000000000..3642aa0c600 --- /dev/null +++ b/TAO/orbsvcs/orbsvcs/PortableGroup/UIPMC_Profile.h @@ -0,0 +1,159 @@ +// -*- C++ -*- + +//============================================================================= +/** + * @file UIPMC_Profile.h + * + * $Id$ + * + * UIPMC profile specific processing + * + * @author Frank Hunleth <fhunleth@cs.wustl.edu> + */ +//============================================================================= + +#ifndef TAO_UIPMC_PROFILE_H +#define TAO_UIPMC_PROFILE_H + +#include /**/ "ace/pre.h" + +#include "orbsvcs/PortableGroup/portablegroup_export.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#include "orbsvcs/PortableGroup/UIPMC_Endpoint.h" + +#include "orbsvcs/PortableGroupC.h" + +#include "tao/Object_KeyC.h" +#include "tao/target_specification.h" +#include "tao/Profile.h" + +#include "ace/SString.h" + +TAO_BEGIN_VERSIONED_NAMESPACE_DECL + +// TAO UIPMC_Profile concrete Profile definitions +/** + * @class TAO_UIPMC_Profile + * + * @brief This class defines the protocol specific attributes required + * for locating ORBs over a TCP/IP network. + * + * This class defines the UIPMC profile as specified in the CORBA + * specification. + * + * @NOTE: This class inherits the ObjectKey from TAO_Profile which may + * not be needed at all! But lets punt on this for the timebeing. + */ +class TAO_PortableGroup_Export TAO_UIPMC_Profile : public TAO_Profile +{ +public: + /// The object key delimiter that UIPMC uses or expects. + static const char object_key_delimiter_; + virtual char object_key_delimiter (void) const; + + /// Return the char string prefix. + static const char *prefix (void); + + /// Profile constructor, default. Used when the profile contents + /// are not yet known or when it is being decoded from an IOR. + TAO_UIPMC_Profile (TAO_ORB_Core *orb_core); + + /// Profile constructor, same as above except the object_key has + /// already been marshaled. + TAO_UIPMC_Profile (const ACE_INET_Addr &addr, + TAO_ORB_Core *orb_core); + + /// Profile constructor. + TAO_UIPMC_Profile (const CORBA::Octet class_d_address[4], + CORBA::UShort port, + TAO_ORB_Core *orb_core); + + /// Create object using a string ior. + TAO_UIPMC_Profile (const char *string, + TAO_ORB_Core *orb_core); + + /// Destructor is to be called only through <_decr_refcnt>. + ~TAO_UIPMC_Profile (void); + + /// Template methods. Please see tao/Profile.h for documentation. + + /// N.B. We have to override the TAO_Profile default decode because + /// in UIPMC there is no object key marshalled and we do not implement + /// a useable ::decode_endpoints + virtual int decode (TAO_InputCDR& cdr); + virtual void parse_string (const char *string); + virtual char * to_string (void); + virtual int encode_endpoints (void); + virtual TAO_Endpoint *endpoint (void); + virtual CORBA::ULong endpoint_count (void) const; + virtual CORBA::ULong hash (CORBA::ULong max); + virtual IOP::TaggedProfile &create_tagged_profile (void); + virtual void request_target_specifier ( + TAO_Target_Specification &target_spec, + TAO_Target_Specification::TAO_Target_Address r); + virtual int supports_multicast (void) const; + virtual void addressing_mode (CORBA::Short addr_mode); + static int extract_group_component (const IOP::TaggedProfile &profile, + PortableGroup::TagGroupTaggedComponent &group); + + /// Add the mandatory group component to this profile. + void set_group_info (const char *domain_id, + PortableGroup::ObjectGroupId group_id, + PortableGroup::ObjectGroupRefVersion ref_version); + + +protected: + /// Template methods, please see documentation in tao/Profile.h + virtual int decode_profile (TAO_InputCDR& cdr); + virtual int decode_endpoints (void); + virtual void parse_string_i (const char *); + virtual void create_profile_body (TAO_OutputCDR &cdr) const; + virtual CORBA::Boolean do_is_equivalent (const TAO_Profile *other_profile); + virtual void update_cached_group_component (void); + +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 UIPMC ProfileBody components. See + * <encode_endpoints> method documentation above for how the rest of + * the endpoint list is transmitted. + */ + TAO_UIPMC_Endpoint endpoint_; + + /// Number of endpoints in the list headed by <endpoint_>. + CORBA::ULong count_; + +private: + + /// Cached version of our tagged profile. + IOP::TaggedProfile tagged_profile_; + + /// Group Domain ID. + ACE_CString group_domain_id_; + + /// Our group ID within the group domain. + PortableGroup::ObjectGroupId group_id_; + + /// The group reference's version. + PortableGroup::ObjectGroupRefVersion ref_version_; + +}; + +TAO_END_VERSIONED_NAMESPACE_DECL + +#include /**/ "ace/post.h" +#endif /* TAO_UIPMC_PROFILE_H */ |