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
|
// -*- C++ -*-
//=============================================================================
/**
* @file 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_LOG_RECORD_STORE_H
#define TAO_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/DsLogAdminC.h"
#include "log_serv_export.h"
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
/**
* @class TAO_LogRecordStore
*
* @brief Abstract base class for storing DsLogAdmin::LogRecord's
*
* Implements a Table Data Gateway(144) for log records, and a Row
* Data Gateway(152) for log channel parameters.
*/
class TAO_Log_Serv_Export TAO_LogRecordStore
{
public:
// = Initialization and termination methods
/// Destructor.
virtual ~TAO_LogRecordStore (void);
/// Initialization.
virtual int open (void) = 0;
/// Close the record store.
virtual int close (void) = 0;
// = Log Parameters
/// Gets the administrative state of the log
virtual DsLogAdmin::AdministrativeState
get_administrative_state (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Sets the administrative state of the log
virtual void
set_administrative_state (DsLogAdmin::AdministrativeState state
ACE_ENV_ARG_DECL) = 0;
/// Get the capacity alarm thresholds
virtual DsLogAdmin::CapacityAlarmThresholdList*
get_capacity_alarm_thresholds (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Set the capacity alarm thresholds
virtual void
set_capacity_alarm_thresholds (const DsLogAdmin::CapacityAlarmThresholdList& thresholds
ACE_ENV_ARG_DECL) = 0;
/// Gets the forwarding state
virtual DsLogAdmin::ForwardingState
get_forwarding_state (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Sets the forwarding state
virtual void
set_forwarding_state (DsLogAdmin::ForwardingState state
ACE_ENV_ARG_DECL) = 0;
/// Get the log duration
virtual DsLogAdmin::TimeInterval
get_interval (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Set the log duration.
virtual void
set_interval (const DsLogAdmin::TimeInterval& interval
ACE_ENV_ARG_DECL) = 0;
/// Gets the log full action
virtual DsLogAdmin::LogFullActionType
get_log_full_action (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Sets the log full action
virtual void
set_log_full_action(DsLogAdmin::LogFullActionType action
ACE_ENV_ARG_DECL) = 0;
/// Gets the max record life
virtual CORBA::ULong
get_max_record_life (ACE_ENV_SINGLE_ARG_DECL) const = 0;
/// Sets the max record life
virtual void
set_max_record_life (CORBA::ULong life
ACE_ENV_ARG_DECL) = 0;
/// 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 = 0;
/// Set the max size of log data. size == 0, => infinite.
virtual void
set_max_size (CORBA::ULongLong size
ACE_ENV_ARG_DECL) = 0;
// = LogRecordStore status methods
/// Gets the current size of the log data.
virtual CORBA::ULongLong
get_current_size (ACE_ENV_SINGLE_ARG_DECL) = 0;
/// Get the number of records in the log right now.
virtual CORBA::ULongLong
get_n_records (ACE_ENV_SINGLE_ARG_DECL) = 0;
// = 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) = 0;
/// 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) = 0;
/// Update into storage.
/// Returns 0 on success -1 on failure.
virtual int
update (DsLogAdmin::LogRecord &rec
ACE_ENV_ARG_DECL) = 0;
/// 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) = 0;
/// Deletes "old" records from the store.
virtual int
purge_old_records (ACE_ENV_SINGLE_ARG_DECL) = 0;
/// Ensure changes have been flushed to persistent media
/// Returns 0 on success, -1 on failure
virtual int
flush (ACE_ENV_SINGLE_ARG_DECL) = 0;
/// 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)) = 0;
/// 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)) = 0;
/// 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)) = 0;
/// 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)) = 0;
/// 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)) = 0;
virtual CORBA::ULong
remove_old_records (ACE_ENV_SINGLE_ARG_DECL) = 0;
protected:
/// Constructor.
TAO_LogRecordStore (void);
private:
};
TAO_END_VERSIONED_NAMESPACE_DECL
#include /**/ "ace/post.h"
#endif /*TAO_LOG_RECORD_STORE_H*/
|
