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
|
// -*- C++ -*-
//=============================================================================
/**
* @file LogRecordStore_persist.h
*
* $Id$
*
* This file declares the tools used to provide the store of
* DsLogAdmin::LogRecords for the Telecom Logging_Service
* NOTE : This file is not built - It is included as a possible example
* of how to add basic flat file persistence.
*
* @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_LOG_RECORD_STORE_PERSIST_H
#define TAO_LOG_RECORD_STORE_PERSIST_H
#include /**/ "ace/pre.h"
#include "orbsvcs/DsLogAdminS.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "orbsvcs/DsLogAdminC.h"
#include "ace/Containers.h"
#include "ace/Hash_Map_Manager.h"
#include "log_serv_export.h"
#include "PersistStore.h"
#define PERSISTENT_LOG_FILE_NAME "LOG.DATA"
#define LOG_DEFAULT_MAX_REC_LIST_LEN 30
/**
* @class TAO_LogRecordStore
*
* @brief A container class for storing DsLogAdmin::LogRecord *'s
*
* 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_LogRecordStore
{
public:
// = Initialization and termination methods
/// Constructor.
TAO_LogRecordStore (CORBA::ULongLong max_size = 0,
DsLogAdmin::LogId logid = 0,
CORBA::ULong max_rec_list_len
= LOG_DEFAULT_MAX_REC_LIST_LEN);
/// Destructor.
~LogRecordStore (void);
/// Initialization.
int open (void);
/// Close the record store.
int close (void);
// = LogRecordStore status methods
/// Get the current set value of the max size of the log data.
CORBA::ULongLong get_max_size (void);
/// Set the max size of log data. size == 0, => infinite.
void set_max_size (CORBA::ULongLong size);
/// Gets the current size of the log data.
CORBA::ULongLong get_current_size (void);
/// Get the number of records in the log right now.
CORBA::ULongLong get_n_records (void);
// = 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.
int log (DsLogAdmin::LogRecord &rec);
/// Set rec to the pointer to the LogRecord with the given
/// id. Returns 0 on success, -1 on failure.
int retrieve (DsLogAdmin::RecordId id, DsLogAdmin::LogRecord &rec);
/// update into storage. Returns 0 on success -1 on failure.
int update (DsLogAdmin::LogRecord &rec);
/// Remove the record with id <id> from the LogRecordStore. Returns 0 on
/// success, -1 on failure.
int remove (DsLogAdmin::RecordId id);
/// Deletes "old" records from the store.
int purge_old_records (void);
/// 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;
/// Get the underlying storage.
/// @@ return a const ref? we don't want anyone to modify the storage.
LogRecordStore::LOG_RECORD_STORE& get_storage (void);
protected:
/// 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 logid_;
/// 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 persistence storage.
PersistStore persist_store_;
/// The hash of LogRecord ids to LogRecord 's.
LogRecordStore::LOG_RECORD_HASH_MAP rec_hash_;
/// Persistent log file name.
char file_name_[256];
};
#include /**/ "ace/post.h"
#endif /*TAO_LOG_RECORD_STORE_PERSIST_H*/
|
