summaryrefslogtreecommitdiff
path: root/ace/Cache_Object.h
blob: f403ec59c894c7c85c77ec8074bc6463792cce55 (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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
/* -*- c++ -*- */
// $Id$

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

#ifndef ACE_CACHE_OBJECT_H
#define ACE_CACHE_OBJECT_H

#include "ace/OS.h"
#include "ace/Synch.h"
#include "ace/Malloc.h"

// @@ 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.

// Cache bucket -- use Hash_Bucket to hold cacheable objects.

class ACE_Cache_Object
{
public:
  ACE_Cache_Object (const void *, size_t);
  virtual ~ACE_Cache_Object (void);

  const void *data (void) const;
  size_t size (void) const;
  u_int count (void) const;

  int acquire (void);
  int release (void);

  time_t last_access (void) const;
  time_t first_access (void) const;

  u_int priority (void) const;

  enum { ACE_CO_REFERENCED, ACE_CO_COUNTED };

  void *heap_item (void) const;
  void heap_item (void *item);

protected:
  virtual u_int count_i (void) const = 0;
  virtual int acquire_i (void) = 0;
  virtual int release_i (void) = 0;
  virtual u_int priority_i (void) const = 0;

private:
  const void *data_;
  size_t size_;

  time_t last_access_;
  time_t first_access_;
  time_t new_last_access_;

  void *heap_item_;
};

class ACE_Referenced_Cache_Object : public ACE_Cache_Object
{
public:
  ACE_Referenced_Cache_Object (const void *, size_t);
  virtual ~ACE_Referenced_Cache_Object (void);

protected:
  virtual u_int count_i (void) const;
  virtual int acquire_i (void);
  virtual int release_i (void);
  virtual u_int priority_i (void) const;

private:
  /* MUTABLE */ ACE_SYNCH_RW_MUTEX count_;
};

class ACE_Counted_Cache_Object : public ACE_Cache_Object
{
public:
  ACE_Counted_Cache_Object (const void *, size_t);
  virtual ~ACE_Counted_Cache_Object (void);

protected:
  virtual u_int count_i (void) const;
  virtual int acquire_i (void);
  virtual int release_i (void);
  virtual u_int priority_i (void) const;

private:
  u_int count_;
  u_int new_count_;
  /* MUTABLE */ ACE_SYNCH_MUTEX lock_;
};

class ACE_Cache_Object_Factory
{
public:
  ACE_Cache_Object_Factory (ACE_Allocator *alloc = 0);
  virtual ~ACE_Cache_Object_Factory (void);

  int open (ACE_Allocator *alloc = 0);

  virtual ACE_Cache_Object * create (const void *, size_t) = 0;
  virtual void destroy (ACE_Cache_Object *) = 0;

protected:
  ACE_Allocator *allocator_;
};

class ACE_Referenced_Cache_Object_Factory : public ACE_Cache_Object_Factory
{
public:
  ACE_Referenced_Cache_Object_Factory (ACE_Allocator *alloc = 0);
  virtual ~ACE_Referenced_Cache_Object_Factory (void);

  virtual ACE_Cache_Object * create (const void *, size_t);
  virtual void destroy (ACE_Cache_Object *);
};

class ACE_Counted_Cache_Object_Factory : public ACE_Cache_Object_Factory
{
public:
  ACE_Counted_Cache_Object_Factory (ACE_Allocator *alloc = 0);
  virtual ~ACE_Counted_Cache_Object_Factory (void);

  virtual ACE_Cache_Object * create (const void *, size_t);
  virtual void destroy (ACE_Cache_Object *);
};

#endif /* UTL_CACHE_OBJECT_H */