summaryrefslogtreecommitdiff
path: root/ace/Cache_Hash_T.h
blob: 0fe5ac0f8ab220f1743c083feb30581bfca17912 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/* -*- c++ -*- */
// $Id$

// @@ James, please add a standard "header" here like you see in all
// the other ACE headerfiles.

#ifndef ACE_CACHE_HASH_T_H
#define ACE_CACHE_HASH_T_H

#include "ace/OS.h"

// @@ James, I think that this #include is wrong...
#include "ace_Cache_Object.h"

// Forward declaration
template <class EXT_ID, class INT_ID, class EQ_FUNC>
class ACE_Hash_Bucket_Manager;

// @@ James, can you please update ALL of these classes and methods to
// use the standard ACE commenting style, i.e., add = TITLE and =
// DESCRIPTION headers and comments for each method.

template <class EXT_ID, class HASH_FUNC, class EQ_FUNC>
class ACE_Cache_Hash
{
public:

  typedef ACE_Hash_Bucket_Manager<EXT_ID, ACE_Cache_Object *, EQ_FUNC>
          CACHE_BUCKET_MANAGER;

  ACE_Cache_Hash (ACE_Allocator *alloc = 0, size_t size = 521);
  // 521 == smallest number > 512 that is prime.  Why is a prime
  // number important?  I am trying to maximize scattering when using
  // mod on the hashed value.  This might be bogus though.

  virtual ~ACE_Cache_Hash (void);

  int find (const EXT_ID &ext_id) const;
  int find (const EXT_ID &ext_id, ACE_Cache_Object *&int_id) const;
  int bind (const EXT_ID &ext_id, ACE_Cache_Object *const &int_id);
  int trybind (const EXT_ID &ext_id, ACE_Cache_Object *&int_id);
  int rebind (const EXT_ID &ext_id, ACE_Cache_Object *const &int_id,
	      EXT_ID &old_ext_id, ACE_Cache_Object *&old_int_id);

  int unbind (const EXT_ID &ext_id);
  int unbind (const EXT_ID &ext_id, ACE_Cache_Object *&int_id);

  size_t size (void) const;

protected:

  virtual u_long hash (const EXT_ID &ext_id) const;
  int isprime (u_long number) const;
  int new_cachebucket (size_t idx);

private:

  ACE_Allocator *allocator_;
  size_t size_;

  ACE_SYNCH_MUTEX lock_;
  CACHE_BUCKET_MANAGER **hashtable_;

};

// @@ James, please also make sure that you add the 
// #if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
// stuff as well... (see other template files to see how this works).

#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "ace_Cache_Hash_T.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */

#endif /* ACE_CACHE_HASH_T_H */