TAO/tao/PortableServer/POA_Current_Impl.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    POA_Current_Impl.h
   6  *
   7  *  @author Irfan Pyarali
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_POA_CURRENT_IMPL_H
  12 #define TAO_POA_CURRENT_IMPL_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/PortableServer/portableserver_export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/PortableServer/PS_ForwardC.h"
  23
  24 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 #ifndef TAO_POA_OBJECT_ID_BUF_SIZE
  27 #define TAO_POA_OBJECT_ID_BUF_SIZE 512
  28 #endif /* TAO_POA_OBJECT_ID_BUF_SIZE */
  29
  30 namespace TAO
  31 {
  32   namespace Portable_Server
  33   {
  34     class Non_Servant_Upcall;
  35     class Servant_Upcall;
  36   }
  37
  38   class ObjectKey;
  39 }
  40
  41 class TAO_TSS_Resources;
  42
  43 namespace TAO
  44 {
  45   namespace Portable_Server
  46   {
  47     /**
  48      * @class POA_Current_Impl
  49      *
  50      * @brief Implementation of the PortableServer::Current object.
  51      *
  52      * Objects of this class hold state information regarding the
  53      * current POA invocation.  Savvy readers will notice that this
  54      * contains substantially more methods than the POA spec shows;
  55      * they exist because the ORB either (a) needs them or (b) finds
  56      * them useful for implementing a more efficient ORB.
  57      * The intent is that instances of this class are held in
  58      * Thread-Specific Storage so that upcalls can get context
  59      * information regarding their invocation.  The POA itself must
  60      * insure that all <set_*> operations are performed in the
  61      * execution thread so that the proper <TAO_POA_Current> pointer
  62      * is obtained from TSS.
  63      */
  64     class TAO_PortableServer_Export POA_Current_Impl
  65     {
  66     public:
  67       friend class ::TAO_Root_POA;
  68
  69       /// Return pointer to the invoking POA.  Raises the
  70       /// CORBA::NoContext exception.
  71       PortableServer::POA_ptr get_POA ();
  72
  73       /**
  74        * Return pointer to the object id through which this was invoked.
  75        * This may be necessary in cases where a <Servant> is serving under
  76        * the guise of multiple object ids.
  77        */
  78       PortableServer::ObjectId *get_object_id ();
  79
  80       /**
  81        * Returns a reference to the servant that hosts the object in whose
  82        * context it is called.
  83        */
  84       PortableServer::Servant get_servant ();
  85
  86       /**
  87        * This operation returns a locally manufactured reference to the object
  88        * in the context of which it is called.
  89        */
  90       CORBA::Object_ptr get_reference ();
  91
  92       /// Set the POA implementation.
  93       void poa (::TAO_Root_POA *);
  94
  95       /// Get the POA implemantation
  96       ::TAO_Root_POA *poa () const;
  97
  98       /// ORB Core for this current.
  99       TAO_ORB_Core &orb_core () const;
 100
 101       /// Set the object ID.
 102       void object_id (const PortableServer::ObjectId &id);
 103
 104       /// Get the object ID.
 105       const PortableServer::ObjectId &object_id () const;
 106
 107       /// Just replace the object id smartly
 108       void replace_object_id (const PortableServer::ObjectId &system_id);
 109
 110       /// Set the object key.
 111       void object_key (const TAO::ObjectKey &key);
 112
 113       /// Get the object key.
 114       const TAO::ObjectKey &object_key () const;
 115
 116       /// Set the servant for the current upcall.
 117       void servant (PortableServer::Servant servant);
 118
 119       /// Get the servant for the current upcall.
 120       PortableServer::Servant servant () const;
 121
 122       /// Set the priority for the current upcall.
 123       void priority (CORBA::Short priority);
 124
 125       /// Get the priority for the current upcall.
 126       CORBA::Short priority () const;
 127
 128       /// Convenience constructor combining construction & initialization.
 129       POA_Current_Impl ();
 130
 131       /// Return the previous current implementation.
 132       POA_Current_Impl *previous () const;
 133
 134       /// Teardown the current for this request.
 135       void teardown ();
 136
 137       /// Setup the current.
 138       void setup (::TAO_Root_POA *impl, const TAO::ObjectKey &key);
 139
 140     private:
 141       // = Hidden because we don't allow these
 142       POA_Current_Impl (const POA_Current_Impl &);
 143       void operator= (const POA_Current_Impl &);
 144
 145     protected:
 146       /// The POA implementation invoking an upcall
 147       ::TAO_Root_POA *poa_ {};
 148
 149       /// In order to avoid memory allocations, we will populate
 150       /// the object id with this buffer.
 151       CORBA::Octet object_id_buf_[TAO_POA_OBJECT_ID_BUF_SIZE];
 152
 153       /**
 154        * The object ID of the current context.  This is the user id and
 155        * not the id the goes into the IOR.  Note also that unlike the
 156        * @c object_key, this field is stored by value.
 157        */
 158       PortableServer::ObjectId object_id_;
 159
 160       /// The object key of the current context.
 161       const TAO::ObjectKey *object_key_;
 162
 163       /// The servant for the current upcall.
 164       PortableServer::Servant servant_;
 165
 166       /// The priority for the current upcall.
 167       CORBA::Short priority_;
 168
 169       /// Current previous from <this>.
 170       POA_Current_Impl *previous_current_impl_;
 171
 172       /// Is setup complete?
 173       bool setup_done_;
 174
 175       /// Pointer to tss resources.
 176       TAO_TSS_Resources *tss_resources_;
 177     };
 178   }
 179 }
 180
 181 TAO_END_VERSIONED_NAMESPACE_DECL
 182
 183 #if defined (__ACE_INLINE__)
 184 # include "tao/PortableServer/POA_Current_Impl.inl"
 185 #endif /* __ACE_INLINE__ */
 186
 187 #include /**/ "ace/post.h"
 188
 189 #endif /* TAO_POA_CURRENT_IMPL_H */