TAO/tao/Cache_Entries_T.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Cache_Entries_T.h
   6  *
   7  *  @author Bala Natarajan  <bala@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_CACHE_ENTRIES_T_H
  12 #define TAO_CACHE_ENTRIES_T_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 # pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 #include "tao/Basic_Types.h"
  21
  22 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  23
  24 #ifdef index
  25 # undef index
  26 #endif  /* index */
  27
  28 namespace TAO
  29 {
  30   /// States of a recyclable object.
  31   /// @todo: see discussion in bugzilla 3024
  32   enum Cache_Entries_State
  33     {
  34       /// Idle and can be purged.
  35       ENTRY_IDLE_AND_PURGABLE,
  36
  37       /// Can be purged, but is not idle (mostly for debugging).
  38       ENTRY_PURGABLE_BUT_NOT_IDLE,
  39
  40       /// Busy (i.e., cannot be recycled or purged).
  41       ENTRY_BUSY,
  42
  43       /// Closed.
  44       ENTRY_CLOSED,
  45
  46       /// Connection in process, but not complete
  47       ENTRY_CONNECTING,
  48
  49       /// Unknown state.
  50       ENTRY_UNKNOWN
  51     };
  52
  53   /**
  54    * @brief Helper class for TAO_Transport_Cache_Manager
  55    *
  56    * Helper class that wraps the <value> part of the Map or
  57    * table holding the Transport state.: unifies data items, so
  58    * they can be stored together as a <value> for a <key> in a
  59    * table holding the state of the Transport Cache.
  60    */
  61   template <typename TRANSPORT_TYPE>
  62   class Cache_IntId_T
  63   {
  64   public:
  65     typedef TRANSPORT_TYPE transport_type;
  66
  67     /// Constructor.
  68     Cache_IntId_T ();
  69
  70     /// Constructor.
  71     Cache_IntId_T (transport_type *transport);
  72
  73     /// Copy constructor.
  74     Cache_IntId_T (const Cache_IntId_T & rhs);
  75
  76     /// Destructor.
  77     ~Cache_IntId_T ();
  78
  79     /// Assignment operator (does copy memory).
  80     Cache_IntId_T& operator= (const Cache_IntId_T &rhs);
  81
  82     /// Equality comparison operator (must match both id_ and kind_).
  83     bool operator== (const Cache_IntId_T &rhs) const;
  84
  85     /// Inequality comparison operator.
  86     bool operator!= (const Cache_IntId_T &rhs) const;
  87
  88     /// Return the underlying transport
  89     transport_type *transport ();
  90
  91     /// Return the underlying transport
  92     const transport_type *transport () const;
  93
  94     /// Set recycle_state.
  95     void recycle_state (Cache_Entries_State new_state);
  96
  97     /// Get recycle_state.
  98     Cache_Entries_State recycle_state () const;
  99
 100     /// Relinquish ownership of the TAO_Transport object associated with
 101     /// this Cache_IntId_T.
 102     /**
 103      * @note This method should go away once the
 104      *       Transport_Cache_Map_Manager is improved so that it returns
 105      *       TAO_Transport objects when performing a find() operation.
 106      *       This method really only exists to get around inadequacies
 107      *       in the Transport_Cache_Map_Manager interface.
 108      */
 109     transport_type *relinquish_transport ();
 110
 111     /// Get the connected flag
 112     bool is_connected () const;
 113
 114     /// Set the connected flag
 115     void is_connected (bool connected);
 116
 117     static const char *state_name (Cache_Entries_State st);
 118
 119   private:
 120     /// The transport that needs to be cached.
 121     transport_type *transport_;
 122
 123     /// The state of the handle
 124     Cache_Entries_State recycle_state_;
 125
 126     /// This is an analog for the transport::is_connected(), which is
 127     /// guarded by a mutex.
 128     bool is_connected_;
 129   };
 130
 131
 132   /**
 133    * @class Cache_ExtId_T
 134    *
 135    * @brief Helper class for TAO_Transport_Cache_Manager: unifies
 136    * several data items, so they can be stored together as a
 137    * @c value for a @c key in a hash table holding the state of the
 138    * Transport Cache.
 139    */
 140   template <typename TRANSPORT_DESCRIPTOR_TYPE>
 141   class Cache_ExtId_T
 142   {
 143   public:
 144     typedef TRANSPORT_DESCRIPTOR_TYPE transport_descriptor_type;
 145
 146     /// Constructor.
 147     Cache_ExtId_T ();
 148
 149     /// Constructor.
 150     explicit Cache_ExtId_T (transport_descriptor_type *prop);
 151
 152     /// Copy constructor.
 153     Cache_ExtId_T (const Cache_ExtId_T & rhs);
 154
 155     /// Destructor.
 156     ~Cache_ExtId_T ();
 157
 158     // = Assignment and comparison operators.
 159     /// Assignment operator (does copy memory).
 160     Cache_ExtId_T& operator= (const Cache_ExtId_T &rhs);
 161
 162     /// Equality comparison operator (must match both id_ and kind_).
 163     bool operator== (const Cache_ExtId_T &rhs) const;
 164
 165     /// Inequality comparison operator.
 166     bool operator!= (const Cache_ExtId_T &rhs) const;
 167
 168     /// hash function is required in order for this class to be usable by
 169     /// ACE_Hash_Map_Manager_Ex.
 170     u_long hash () const;
 171
 172     /// Make a deep copy of the underlying pointer
 173     void duplicate ();
 174
 175     /// Return the index value
 176     CORBA::ULong index () const;
 177
 178     /// Set the index value. This calls should not be used by any users
 179     /// but for the TAO_Transport_Cache_Manager class.
 180     void index (CORBA::ULong index);
 181
 182     /// Increment the index value
 183     void incr_index ();
 184
 185     // = Accessors
 186     /// Get the underlying the property pointer
 187     transport_descriptor_type *property () const;
 188
 189   private:
 190     /// A property object that we represent.
 191     transport_descriptor_type *transport_property_;
 192
 193     /// Do we need to delete transport_property?
 194     bool is_delete_;
 195
 196     /**
 197      * This is a supplementary index. Would be set to zero by
 198      * default. Would be altered by the Transport_Cache of TAO. Please
 199      * see the documentation of TAO_Transport_Cache_Manager for
 200      * details.
 201      */
 202     CORBA::ULong index_;
 203   };
 204 }
 205
 206 TAO_END_VERSIONED_NAMESPACE_DECL
 207
 208 #if defined (__ACE_INLINE__)
 209 # include "tao/Cache_Entries_T.inl"
 210 #endif /* __ACE_INLINE__ */
 211
 212 #include "tao/Cache_Entries_T.cpp"
 213
 214 #include /**/ "ace/post.h"
 215
 216 #endif /* TAO_CACHE_ENTRIES_T_H */