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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef _STORE_LOCKBYTE_HXX_
#define _STORE_LOCKBYTE_HXX_
#include "sal/types.h"
#include "rtl/ref.hxx"
#include "rtl/ustring.h"
#include "store/types.h"
#include "storbase.hxx"
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();
protected:
~ILockBytes() {}
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;
};
/*========================================================================
*
* 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_ */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
