TAO/tao/Tagged_Profile.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Tagged_Profile.h
   6  *
   7  *  @author Bala Natarajan <bala@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_TAGGED_PROFILE_H
  12 #define TAO_TAGGED_PROFILE_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/IOPC.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/Object_KeyC.h"
  23 #include /**/ "tao/Versioned_Namespace.h"
  24 #include "ace/SString.h"
  25
  26 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  27
  28 namespace TAO
  29 {
  30   namespace CSD
  31   {
  32     class FW_Server_Request_Wrapper;
  33   }
  34 }
  35
  36 /**
  37  * @class TAO_Tagged_Profile
  38  *
  39  * @brief This class is used to manipulate and access the target
  40  *        address field of a GIOP 1.2 request.
  41  */
  42 class TAO_Export TAO_Tagged_Profile
  43 {
  44 public:
  45   /// Declare FW_Server_Request_Wrapper a friend
  46   /// This friendship makes the FW_Server_Request_Wrapper be able to
  47   /// clone the TAO_Tagged_Profile data member in TAO_ServerRequest.
  48   friend class TAO::CSD::FW_Server_Request_Wrapper;
  49
  50   /// Ctor
  51   TAO_Tagged_Profile (TAO_ORB_Core *orb_core);
  52
  53   /// Unmarshal the GIOP 1.2 target address field.
  54   CORBA::Boolean unmarshall_target_address (TAO_InputCDR &cdr);
  55
  56   /// Unmarshals the received object key for GIOP 1.0/1.1
  57   CORBA::Boolean unmarshall_object_key (TAO_InputCDR &cdr);
  58
  59   /// Return the object key
  60   TAO::ObjectKey &object_key ();
  61
  62   /// Save the object key
  63   void object_key (TAO::ObjectKey &object_key);
  64
  65   /// Return a const object key
  66   const TAO::ObjectKey &object_key () const;
  67
  68   /// Get the tagged_profile
  69   const IOP::TaggedProfile &tagged_profile () const;
  70
  71   /// Get the profile index, that needs to be used in the
  72   /// sequnce of TaggedProfiles contained  IOP::IOR that is
  73   /// received from the client.
  74   CORBA::ULong profile_index () const;
  75
  76   /// Accessor to the type_id contained in the IOP::IOR received from
  77   /// the client.
  78   const char* type_id () const;
  79
  80   CORBA::Short discriminator () const;
  81
  82 private:
  83   /// Extract the object key from the TaggedProfile and store it in
  84   /// <object_key_>
  85   CORBA::Boolean extract_object_key (IOP::TaggedProfile &profile);
  86
  87   /// Unmarshals the received object key
  88   CORBA::Boolean unmarshall_object_key_i (TAO_InputCDR &cdr);
  89
  90   /// Unmarshall the IOP::TaggedProfile
  91   CORBA::Boolean unmarshall_iop_profile_i (TAO_InputCDR &cdr);
  92
  93   /// Unmarshalls the GIOP::IORAddressingInfo
  94   CORBA::Boolean unmarshall_ref_addr_i (TAO_InputCDR &cdr);
  95
  96 private:
  97   /// Our ORB Core
  98   TAO_ORB_Core *orb_core_;
  99
 100   /// Keep track of which kind of target profile that was extracted.
 101   CORBA::Short discriminator_;
 102
 103   /// Flag to denote whether the object key has been extracted yet.
 104   CORBA::Boolean object_key_extracted_;
 105
 106   /// The object key
 107   TAO::ObjectKey object_key_;
 108
 109   /// The Tagged profile. This class would have the Tagged Profile
 110   IOP::TaggedProfile profile_;
 111
 112   /*
 113    * The GIOP::IORAddressingInfo is defined as follows
 114    *   struct IORAddressingInfo
 115    *     {
 116    *       unsigned long selected_profile_index;
 117    *       IOP::IOR ior;
 118    *     };
 119    *
 120    * and the IOP::IOR is defined to be
 121    *   struct IOR
 122    *      {
 123    *        string type_id;
 124    *        sequence<TaggedProfile>   profiles;
 125    *      };
 126    * The mapping for the type_id of type string is TAO::String_Manager
 127    * which does lot of bad things like allocation on construction and
 128    * a deallocation on destruction. This is bad along the critical
 129    * path. So we will store this nested structure ripped open with the
 130    * profile_index and the type_id with the TaggedProfile that is
 131    * pointed to.
 132    */
 133
 134   /// The profile index incase we receive a GIOP::IORAddressingInfo
 135   /// information
 136   CORBA::ULong profile_index_;
 137
 138   /// The type_id in the IOP::IOR in case we receive the
 139   /// GIOP::IORAddressingInfo information.
 140   const char* type_id_;
 141 };
 142
 143 TAO_END_VERSIONED_NAMESPACE_DECL
 144
 145 #if defined (__ACE_INLINE__)
 146 # include "tao/Tagged_Profile.inl"
 147 #endif /* __ACE_INLINE__ */
 148
 149 #include /**/ "ace/post.h"
 150
 151 #endif /*TAO_TAGGED_PROFILE_H*/