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
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// orbsvcs
//
// = FILENAME
// LogRecordStore.h
//
// = DESCRIPTION
// This file declares the tools used to provide the store of
// DsLogAdmin::LogRecords for the Telecom Logging_Service
//
// = AUTHORS
// Matthew Braun (mjb2@cs.wustl.edu) and Pradeep Gore <pradeep@cs.wustl.edu>
//
// ============================================================================
#ifndef LOG_RECORD_STORE_H
#define LOG_RECORD_STORE_H
#include "orbsvcs/DsLogAdminS.h"
#include "orbsvcs/DsLogAdminC.h"
#include "ace/Containers.h"
#include "ace/Hash_Map_Manager.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#define LOG_DEFAULT_MAX_REC_LIST_LEN 30
class LogRecordStore
{
// = TITLE
// A container class for storing DsLogAdmin::LogRecord *'s
//
// = Description
// 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.
public:
// = Initialization and termination methods
LogRecordStore (CORBA::ULongLong max_size = 0,
CORBA::ULong max_rec_list_len
= LOG_DEFAULT_MAX_REC_LIST_LEN);
// Constructor
~LogRecordStore (void);
// Destructor
int open (void);
// Initialization.
int close (void);
// Close the record store.
// = LogRecordStore status methods
CORBA::ULongLong get_max_size (void);
// Get the current set value of the max size of the log data.
void set_max_size (CORBA::ULongLong size);
// Set the max size of log data. size == 0, => infinite.
CORBA::ULongLong get_current_size (void);
// Gets the current size of the log data.
CORBA::ULongLong get_n_records (void);
// Get the number of records in the log right now.
// = Record logging, retrieval, update and removal methods
int log (DsLogAdmin::LogRecord &rec);
// Insert rec into storage. Returns 0 on success -1 on failure and 1
// if the log is full
int retrieve (DsLogAdmin::RecordId id, DsLogAdmin::LogRecord &rec);
// Set rec to the pointer to the LogRecord with the given
// id. Returns 0 on success, -1 on failure
int update (DsLogAdmin::LogRecord &rec);
// update into storage. Returns 0 on success -1 on failure
int remove (DsLogAdmin::RecordId id);
// Remove the record with id <id> from the LogRecordStore. Returns 0 on
// success, -1 on failure.
int purge_old_records (void);
// Deletes "old" records from the store.
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;
// Defines macros to represent the hash that maps ids to
// DsLogAdmin::LogRecords.
typedef LOG_RECORD_HASH_MAP_ITER LOG_RECORD_STORE_ITER;
typedef LOG_RECORD_HASH_MAP LOG_RECORD_STORE;
// Don't want to be tied to hash maps!.
LogRecordStore::LOG_RECORD_STORE& get_storage (void);
// Get the underlying storage.
// @@ return a const ref? we don't want anyone to modify the storage.
protected:
LogRecordStore::LOG_RECORD_HASH_MAP rec_hash_;
// The hash of LogRecord ids to LogRecord 's
DsLogAdmin::RecordId maxid_;
// Assigned to a new RecordId and then incremented
// @@ Should I have a list of reclaimed id's for when records are
// deleted?
CORBA::ULongLong max_size_;
// The maximum size of the log.
CORBA::ULongLong current_size_;
// The current size (in bytes) of the log
CORBA::ULongLong num_records_;
// The current number of records in the log
CORBA::ULong max_rec_list_len_;
// The max size of the record list returned in a query.
};
#endif /*LOG_RECORD_STORE_H*/
|
