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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
// -*- C++ -*-
//=============================================================================
/**
* @file Hash_LogRecordStore.h
*
* $Id$
*
* @author Matthew Braun <mjb2@cs.wustl.edu>
* @author Pradeep Gore <pradeep@cs.wustl.edu>
* @author David A. Hanvey <d.hanvey@qub.ac.uk>
*/
//=============================================================================
#ifndef TAO_HASH_LOG_RECORD_STORE_H
#define TAO_HASH_LOG_RECORD_STORE_H
#include /**/ "ace/pre.h"
#include /**/ "ace/config-all.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "orbsvcs/Log/LogRecordStore.h"
#include "ace/Containers.h"
#include "ace/Hash_Map_Manager.h"
#include "ace/Synch_Traits.h"
#include "ace/Null_Mutex.h"
#include "ace/RW_Thread_Mutex.h"
#include "ace/Reactor.h"
#include "log_serv_export.h"
#define LOG_DEFAULT_MAX_REC_LIST_LEN 100
/**
* @class TAO_Hash_LogRecordStore
*
* @brief A concrete container class for storing DsLogAdmin::LogRecords
*
* This implementation uses an ACE_RB_Tree and and ACE_Hash_Map
* internally to store the pointers. Permits fast searches by id
* and iteration, while allowing for ring-buffer like wrapping of
* entries. Other features include searching by time ranges.
* @@ pradeep: The ACE_RB_Tree will come later.
*/
class TAO_Log_Serv_Export TAO_Hash_LogRecordStore
: public TAO_LogRecordStore
{
public:
// = Initialization and termination methods
/// Constructor.
TAO_Hash_LogRecordStore (CORBA::ORB_ptr orb,
DsLogAdmin::LogId id,
DsLogAdmin::LogFullActionType log_full_action,
CORBA::ULongLong max_size,
const DsLogAdmin::CapacityAlarmThresholdList* thresholds
);
/// Destructor.
virtual ~TAO_Hash_LogRecordStore (void);
/// Initialization.
virtual int open (void);
/// Close the record store.
virtual int close (void);
// = Log Parameters
/// Gets the administrative state of the log
virtual DsLogAdmin::AdministrativeState
get_administrative_state (ACE_ENV_SINGLE_ARG_DECL) const;
/// Sets the administrative state of the log
virtual void
set_administrative_state (DsLogAdmin::AdministrativeState
ACE_ENV_ARG_DECL);
/// Get the capacity alarm thresholds
virtual DsLogAdmin::CapacityAlarmThresholdList*
get_capacity_alarm_thresholds (ACE_ENV_SINGLE_ARG_DECL) const;
/// Set the capacity alarm thresholds
virtual void
set_capacity_alarm_thresholds (const DsLogAdmin::CapacityAlarmThresholdList& thresholds
ACE_ENV_ARG_DECL);
/// Gets the forwarding state
virtual DsLogAdmin::ForwardingState
get_forwarding_state (ACE_ENV_SINGLE_ARG_DECL) const;
/// Sets the forwarding state
virtual void
set_forwarding_state (DsLogAdmin::ForwardingState state
ACE_ENV_ARG_DECL);
/// Get the log duration
virtual DsLogAdmin::TimeInterval
get_interval (ACE_ENV_SINGLE_ARG_DECL) const;
/// Set the log duration.
virtual void
set_interval (const DsLogAdmin::TimeInterval & interval
ACE_ENV_ARG_DECL);
/// Gets the log full action
virtual DsLogAdmin::LogFullActionType
get_log_full_action (ACE_ENV_SINGLE_ARG_DECL) const;
/// Sets the log full action
virtual void
set_log_full_action(DsLogAdmin::LogFullActionType action
ACE_ENV_ARG_DECL);
/// Gets the max record life
virtual CORBA::ULong
get_max_record_life (ACE_ENV_SINGLE_ARG_DECL) const;
/// Sets the max record life
virtual void
set_max_record_life (CORBA::ULong life
ACE_ENV_ARG_DECL);
/// Get the current set value of the max size of the log data.
virtual CORBA::ULongLong
get_max_size (ACE_ENV_SINGLE_ARG_DECL) const;
/// Set the max size of log data. size == 0, => infinite.
virtual void
set_max_size (CORBA::ULongLong size
ACE_ENV_ARG_DECL);
// = LogRecordStore status methods
/// Gets the current size of the log data.
virtual CORBA::ULongLong
get_current_size (ACE_ENV_SINGLE_ARG_DECL);
/// Get the number of records in the log right now.
virtual CORBA::ULongLong
get_n_records (ACE_ENV_SINGLE_ARG_DECL);
// = Record logging, retrieval, update and removal methods.
/// Insert rec into storage. Returns 0 on success -1 on failure and 1
/// if the log is full.
virtual int
log (const DsLogAdmin::LogRecord &rec ACE_ENV_ARG_DECL);
/// Set rec to the pointer to the LogRecord with the given
/// id. Returns 0 on success, -1 on failure.
virtual int
retrieve (DsLogAdmin::RecordId id,
DsLogAdmin::LogRecord &rec
ACE_ENV_ARG_DECL);
/// Update into storage. Returns 0 on success -1 on failure.
virtual int
update (DsLogAdmin::LogRecord &rec
ACE_ENV_ARG_DECL);
/// Remove the record with id <id> from the LogRecordStore.
/// Returns 0 on success, -1 on failure.
virtual int
remove (DsLogAdmin::RecordId id
ACE_ENV_ARG_DECL);
/// Deletes "old" records from the store.
virtual int
purge_old_records (ACE_ENV_SINGLE_ARG_DECL);
/// Ensure changes have been flushed to persistent media
/// Returns 0 on success, -1 on failure.
virtual int
flush (ACE_ENV_SINGLE_ARG_DECL);
/// Returns all records in the log that match the given constraint
/// <c>.
virtual DsLogAdmin::RecordList*
query (const char * grammar,
const char * c,
DsLogAdmin::Iterator_out i
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
/// Retrieve <how_many> records from time <from_time> using iterator
/// <i>.
virtual DsLogAdmin::RecordList*
retrieve (DsLogAdmin::TimeT from_time,
CORBA::Long how_many,
DsLogAdmin::Iterator_out i
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException));
/// Returns the number of records matching constraint <c>.
virtual CORBA::ULong
match (const char * grammar,
const char * c
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
/// Delete records matching constraint <c>.
virtual CORBA::ULong
delete_records (const char * grammar,
const char * c
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar,
DsLogAdmin::InvalidConstraint));
/// Delete records matching ids in <ids>
virtual CORBA::ULong
delete_records_by_id (const DsLogAdmin::RecordIdList & ids
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException));
virtual CORBA::ULong
remove_old_records (ACE_ENV_SINGLE_ARG_DECL);
/* protected: */
/// Defines macros to represent the hash that maps ids to
/// DsLogAdmin::LogRecords.
typedef ACE_Hash_Map_Manager <DsLogAdmin::RecordId,
DsLogAdmin::LogRecord, ACE_Null_Mutex> LOG_RECORD_HASH_MAP;
typedef ACE_Hash_Map_Iterator <DsLogAdmin::RecordId,
DsLogAdmin::LogRecord, ACE_Null_Mutex> LOG_RECORD_HASH_MAP_ITER;
typedef ACE_Hash_Map_Entry <DsLogAdmin::RecordId,
DsLogAdmin::LogRecord> LOG_RECORD_HASH_MAP_ENTRY;
/// Don't want to be tied to hash maps!.
typedef LOG_RECORD_HASH_MAP_ITER LOG_RECORD_STORE_ITER;
typedef LOG_RECORD_HASH_MAP LOG_RECORD_STORE;
typedef LOG_RECORD_HASH_MAP_ENTRY LOG_RECORD_STORE_ENTRY;
protected:
DsLogAdmin::RecordList* query_i (const char *constraint,
DsLogAdmin::Iterator_out &iter_out,
CORBA::ULong how_many
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidConstraint));
CORBA::ULong match_i (const char *constraint,
CORBA::Boolean delete_rec
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidConstraint));
int remove_i (DsLogAdmin::RecordId id);
/// Throws DsLogAdmin::InvalidGrammar if we don't support this grammar.
void check_grammar (const char* grammar ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((CORBA::SystemException,
DsLogAdmin::InvalidGrammar));
/// The size of a LogRecord
size_t log_record_size(const DsLogAdmin::LogRecord &rec);
/// Assigned to a new RecordId and then incremented
/// @@ Should I have a list of reclaimed id's for when records are
/// deleted?
DsLogAdmin::RecordId maxid_;
/// The maximum size of the log.
CORBA::ULongLong max_size_;
/// The log id to which this LogRecordStore relates.
DsLogAdmin::LogId id_;
/// The current size (in bytes) of the log.
CORBA::ULongLong current_size_;
/// The current number of records in the log.
CORBA::ULongLong num_records_;
/// The max size of the record list returned in a query.
CORBA::ULong max_rec_list_len_;
/// The hash of LogRecord ids to LogRecord 's
TAO_Hash_LogRecordStore::LOG_RECORD_HASH_MAP rec_hash_;
/// The administrative state of the log
DsLogAdmin::AdministrativeState admin_state_;
DsLogAdmin::CapacityAlarmThresholdList
thresholds_;
/// The forwarding state of the log
DsLogAdmin::ForwardingState forward_state_;
/// The interval during which the log should be in operation
DsLogAdmin::TimeInterval interval_;
/// The action to take if the log reaches max capacity
DsLogAdmin::LogFullActionType log_full_action_;
/// The maximum record lifetime
CORBA::ULong max_record_life_;
ACE_Reactor* reactor_;
mutable ACE_SYNCH_RW_MUTEX lock_;
};
#include /**/ "ace/post.h"
#endif /*TAO_HASH_LOG_RECORD_STORE_H*/
|
