TAO/tao/PortableServer/Key_Adapters.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Key_Adapters.h
   6  *
   7  *  @author Irfan Pyarali
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_KEY_ADAPTERS_H
  12 #define TAO_KEY_ADAPTERS_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 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25 class ACE_Active_Map_Manager_Key;
  26 ACE_END_VERSIONED_NAMESPACE_DECL
  27
  28 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  29
  30 ///////////////////////////////////////////////////////////////////////////////
  31
  32 /**
  33  * @class TAO_Incremental_Key_Generator
  34  *
  35  * @brief Defines a key generator.
  36  *
  37  * This class is used in adapters of maps that do not produce keys.
  38  */
  39 class TAO_Incremental_Key_Generator
  40 {
  41 public:
  42   TAO_Incremental_Key_Generator ();
  43
  44   int operator() (PortableServer::ObjectId &id);
  45
  46 protected:
  47   CORBA::ULong counter_;
  48 };
  49
  50 ////////////////////////////////////////////////////////////////////////////////
  51
  52 /**
  53  * @class TAO_ObjectId_Hash
  54  *
  55  * @brief Hashing class for Object Ids.
  56  *
  57  * Define the hash() method for Object Ids.
  58  */
  59 class TAO_PortableServer_Export TAO_ObjectId_Hash
  60 {
  61 public:
  62   /// Returns hash value.
  63   u_long operator () (const PortableServer::ObjectId &id) const;
  64 };
  65
  66 ////////////////////////////////////////////////////////////////////////////////
  67
  68 /**
  69  * @class TAO_Ignore_Original_Key_Adapter
  70  *
  71  * @brief A key adapter (encode/decode) class.
  72  *
  73  * Define the encoding and decoding methods for converting
  74  * between Object Ids and active keys.  This class ignores the
  75  * <original_key> passed to it.
  76  */
  77 class TAO_Ignore_Original_Key_Adapter
  78 {
  79 public:
  80   int encode (const PortableServer::ObjectId &original_key,
  81               const ACE_Active_Map_Manager_Key &active_key,
  82               PortableServer::ObjectId &modified_key);
  83
  84   int decode (const PortableServer::ObjectId &modified_key,
  85               ACE_Active_Map_Manager_Key &active_key);
  86
  87   int decode (const PortableServer::ObjectId &modified_key,
  88               PortableServer::ObjectId &original_key);
  89 };
  90
  91 ////////////////////////////////////////////////////////////////////////////////
  92
  93 /**
  94  * @class TAO_Preserve_Original_Key_Adapter
  95  *
  96  * @brief A key adapter (encode/decode) class.
  97  *
  98  * Define the encoding and decoding methods for converting
  99  * between Object Ids and active keys.  This class remembers the
 100  * <original_key> passed to it.
 101  */
 102 class TAO_Preserve_Original_Key_Adapter
 103 {
 104 public:
 105   int encode (const PortableServer::ObjectId &original_key,
 106               const ACE_Active_Map_Manager_Key &active_key,
 107               PortableServer::ObjectId &modified_key);
 108
 109   int decode (const PortableServer::ObjectId &modified_key,
 110               ACE_Active_Map_Manager_Key &active_key);
 111
 112   int decode (const PortableServer::ObjectId &modified_key,
 113               PortableServer::ObjectId &original_key);
 114 };
 115
 116 ///////////////////////////////////////////////////////////////////////////////
 117
 118 TAO_END_VERSIONED_NAMESPACE_DECL
 119
 120 #include /**/ "ace/post.h"
 121
 122 #endif /* TAO_KEY_ADAPTERS_H */