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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _STORE_LOCKBYTE_HXX_
#define _STORE_LOCKBYTE_HXX_ "$Revision: 1.1.2.1 $"
#ifndef _SAL_TYPES_H_
#include "sal/types.h"
#endif
#ifndef _RTL_REF_HXX_
#include "rtl/ref.hxx"
#endif
#ifndef _RTL_USTRING_H_
#include "rtl/ustring.h"
#endif
#ifndef _STORE_TYPES_H_
#include "store/types.h"
#endif
#ifndef _STORE_STORBASE_HXX_
#include "storbase.hxx"
#endif
namespace store
{
/*========================================================================
*
* ILockBytes interface.
*
*======================================================================*/
class ILockBytes : public rtl::IReference
{
public:
/**
@param rxAllocator [out]
@param nPageSize [in]
*/
storeError initialize (
rtl::Reference< PageData::Allocator > & rxAllocator,
sal_uInt16 nPageSize);
/**
@param rPage [out]
@param nOffset [in]
*/
storeError readPageAt (
PageHolder & rPage,
sal_uInt32 nOffset);
/**
@param rPage [in]
@param nOffset [in]
*/
storeError writePageAt (
PageHolder const & rPage,
sal_uInt32 nOffset);
/**
@param nOffset [in]
@param pBuffer [out]
@param nBytes [in]
@return store_E_None upon success
*/
storeError readAt (
sal_uInt32 nOffset,
void *pBuffer,
sal_uInt32 nBytes);
/**
@param nOffset [in]
@param pBuffer [in]
@param nBytes [in]
@return store_E_None upon success
*/
storeError writeAt (
sal_uInt32 nOffset,
const void *pBuffer,
sal_uInt32 nBytes);
/**
@param rnSize [out]
@return store_E_None upon success
*/
storeError getSize (sal_uInt32 & rnSize);
/**
@param nSize [in]
@return store_E_None upon success
*/
storeError setSize (sal_uInt32 nSize);
/**
@return store_E_None upon success
*/
storeError flush();
/**
@param nOffset [in]
@param nBytes [in]
@return store_E_None upon success
store_E_LockingViolation
*/
storeError lockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
/**
@param nOffset [in]
@param nBytes [in]
@return store_E_None upon success
store_E_LockingViolation
*/
storeError unlockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
private:
/** Implementation (abstract).
*/
virtual storeError initialize_Impl (
rtl::Reference< PageData::Allocator > & rxAllocator,
sal_uInt16 nPageSize) = 0;
virtual storeError readPageAt_Impl (
PageHolder & rPage,
sal_uInt32 nOffset) = 0;
virtual storeError writePageAt_Impl (
PageHolder const & rPage,
sal_uInt32 nOffset) = 0;
virtual storeError readAt_Impl (
sal_uInt32 nOffset,
void *pBuffer,
sal_uInt32 nBytes) = 0;
virtual storeError writeAt_Impl (
sal_uInt32 nOffset,
const void *pBuffer,
sal_uInt32 nBytes) = 0;
virtual storeError getSize_Impl (
sal_uInt32 & rnSize) = 0;
virtual storeError setSize_Impl (
sal_uInt32 nSize) = 0;
virtual storeError flush_Impl() = 0;
#ifdef STORE_FEATURE_LOCKING
virtual storeError lockRange_Impl (
sal_uInt32 nOffset,
sal_uInt32 nBytes) = 0;
virtual storeError unlockRange_Impl (
sal_uInt32 nOffset,
sal_uInt32 nBytes) = 0;
#endif /* STORE_FEATURE_LOCKING */
};
/*========================================================================
*
* ILockBytes factories.
*
*======================================================================*/
storeError
FileLockBytes_createInstance (
rtl::Reference< store::ILockBytes > & rxLockBytes,
rtl_uString * pFilename,
storeAccessMode eAccessMode
);
storeError
MemoryLockBytes_createInstance (
rtl::Reference< store::ILockBytes > & rxLockBytes
);
/*========================================================================
*
* The End.
*
*======================================================================*/
} // namespace store
#endif /* !_STORE_LOCKBYTE_HXX_ */
|
