1*1a5fa39bSAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*1a5fa39bSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*1a5fa39bSAndrew Rist * or more contributor license agreements. See the NOTICE file 5*1a5fa39bSAndrew Rist * distributed with this work for additional information 6*1a5fa39bSAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*1a5fa39bSAndrew Rist * to you under the Apache License, Version 2.0 (the 8*1a5fa39bSAndrew Rist * "License"); you may not use this file except in compliance 9*1a5fa39bSAndrew Rist * with the License. You may obtain a copy of the License at 10*1a5fa39bSAndrew Rist * 11*1a5fa39bSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*1a5fa39bSAndrew Rist * 13*1a5fa39bSAndrew Rist * Unless required by applicable law or agreed to in writing, 14*1a5fa39bSAndrew Rist * software distributed under the License is distributed on an 15*1a5fa39bSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*1a5fa39bSAndrew Rist * KIND, either express or implied. See the License for the 17*1a5fa39bSAndrew Rist * specific language governing permissions and limitations 18*1a5fa39bSAndrew Rist * under the License. 19*1a5fa39bSAndrew Rist * 20*1a5fa39bSAndrew Rist *************************************************************/ 21*1a5fa39bSAndrew Rist 22*1a5fa39bSAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef _STORE_LOCKBYTE_HXX_ 25cdf0e10cSrcweir #define _STORE_LOCKBYTE_HXX_ 26cdf0e10cSrcweir 27cdf0e10cSrcweir #ifndef _SAL_TYPES_H_ 28cdf0e10cSrcweir #include "sal/types.h" 29cdf0e10cSrcweir #endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir #ifndef _RTL_REF_HXX_ 32cdf0e10cSrcweir #include "rtl/ref.hxx" 33cdf0e10cSrcweir #endif 34cdf0e10cSrcweir #ifndef _RTL_USTRING_H_ 35cdf0e10cSrcweir #include "rtl/ustring.h" 36cdf0e10cSrcweir #endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir #ifndef _STORE_TYPES_H_ 39cdf0e10cSrcweir #include "store/types.h" 40cdf0e10cSrcweir #endif 41cdf0e10cSrcweir #ifndef _STORE_STORBASE_HXX_ 42cdf0e10cSrcweir #include "storbase.hxx" 43cdf0e10cSrcweir #endif 44cdf0e10cSrcweir 45cdf0e10cSrcweir namespace store 46cdf0e10cSrcweir { 47cdf0e10cSrcweir 48cdf0e10cSrcweir /*======================================================================== 49cdf0e10cSrcweir * 50cdf0e10cSrcweir * ILockBytes interface. 51cdf0e10cSrcweir * 52cdf0e10cSrcweir *======================================================================*/ 53cdf0e10cSrcweir class ILockBytes : public rtl::IReference 54cdf0e10cSrcweir { 55cdf0e10cSrcweir public: 56cdf0e10cSrcweir /** 57cdf0e10cSrcweir @param rxAllocator [out] 58cdf0e10cSrcweir @param nPageSize [in] 59cdf0e10cSrcweir */ 60cdf0e10cSrcweir storeError initialize ( 61cdf0e10cSrcweir rtl::Reference< PageData::Allocator > & rxAllocator, 62cdf0e10cSrcweir sal_uInt16 nPageSize); 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** 65cdf0e10cSrcweir @param rPage [out] 66cdf0e10cSrcweir @param nOffset [in] 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir storeError readPageAt ( 69cdf0e10cSrcweir PageHolder & rPage, 70cdf0e10cSrcweir sal_uInt32 nOffset); 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** 73cdf0e10cSrcweir @param rPage [in] 74cdf0e10cSrcweir @param nOffset [in] 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir storeError writePageAt ( 77cdf0e10cSrcweir PageHolder const & rPage, 78cdf0e10cSrcweir sal_uInt32 nOffset); 79cdf0e10cSrcweir 80cdf0e10cSrcweir /** 81cdf0e10cSrcweir @param nOffset [in] 82cdf0e10cSrcweir @param pBuffer [out] 83cdf0e10cSrcweir @param nBytes [in] 84cdf0e10cSrcweir @return store_E_None upon success 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir storeError readAt ( 87cdf0e10cSrcweir sal_uInt32 nOffset, 88cdf0e10cSrcweir void *pBuffer, 89cdf0e10cSrcweir sal_uInt32 nBytes); 90cdf0e10cSrcweir 91cdf0e10cSrcweir /** 92cdf0e10cSrcweir @param nOffset [in] 93cdf0e10cSrcweir @param pBuffer [in] 94cdf0e10cSrcweir @param nBytes [in] 95cdf0e10cSrcweir @return store_E_None upon success 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir storeError writeAt ( 98cdf0e10cSrcweir sal_uInt32 nOffset, 99cdf0e10cSrcweir const void *pBuffer, 100cdf0e10cSrcweir sal_uInt32 nBytes); 101cdf0e10cSrcweir 102cdf0e10cSrcweir /** 103cdf0e10cSrcweir @param rnSize [out] 104cdf0e10cSrcweir @return store_E_None upon success 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir storeError getSize (sal_uInt32 & rnSize); 107cdf0e10cSrcweir 108cdf0e10cSrcweir /** 109cdf0e10cSrcweir @param nSize [in] 110cdf0e10cSrcweir @return store_E_None upon success 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir storeError setSize (sal_uInt32 nSize); 113cdf0e10cSrcweir 114cdf0e10cSrcweir /** 115cdf0e10cSrcweir @return store_E_None upon success 116cdf0e10cSrcweir */ 117cdf0e10cSrcweir storeError flush(); 118cdf0e10cSrcweir 119cdf0e10cSrcweir private: 120cdf0e10cSrcweir /** Implementation (abstract). 121cdf0e10cSrcweir */ 122cdf0e10cSrcweir virtual storeError initialize_Impl ( 123cdf0e10cSrcweir rtl::Reference< PageData::Allocator > & rxAllocator, 124cdf0e10cSrcweir sal_uInt16 nPageSize) = 0; 125cdf0e10cSrcweir 126cdf0e10cSrcweir virtual storeError readPageAt_Impl ( 127cdf0e10cSrcweir PageHolder & rPage, 128cdf0e10cSrcweir sal_uInt32 nOffset) = 0; 129cdf0e10cSrcweir 130cdf0e10cSrcweir virtual storeError writePageAt_Impl ( 131cdf0e10cSrcweir PageHolder const & rPage, 132cdf0e10cSrcweir sal_uInt32 nOffset) = 0; 133cdf0e10cSrcweir 134cdf0e10cSrcweir virtual storeError readAt_Impl ( 135cdf0e10cSrcweir sal_uInt32 nOffset, 136cdf0e10cSrcweir void *pBuffer, 137cdf0e10cSrcweir sal_uInt32 nBytes) = 0; 138cdf0e10cSrcweir 139cdf0e10cSrcweir virtual storeError writeAt_Impl ( 140cdf0e10cSrcweir sal_uInt32 nOffset, 141cdf0e10cSrcweir const void *pBuffer, 142cdf0e10cSrcweir sal_uInt32 nBytes) = 0; 143cdf0e10cSrcweir 144cdf0e10cSrcweir virtual storeError getSize_Impl ( 145cdf0e10cSrcweir sal_uInt32 & rnSize) = 0; 146cdf0e10cSrcweir 147cdf0e10cSrcweir virtual storeError setSize_Impl ( 148cdf0e10cSrcweir sal_uInt32 nSize) = 0; 149cdf0e10cSrcweir 150cdf0e10cSrcweir virtual storeError flush_Impl() = 0; 151cdf0e10cSrcweir }; 152cdf0e10cSrcweir 153cdf0e10cSrcweir /*======================================================================== 154cdf0e10cSrcweir * 155cdf0e10cSrcweir * ILockBytes factories. 156cdf0e10cSrcweir * 157cdf0e10cSrcweir *======================================================================*/ 158cdf0e10cSrcweir 159cdf0e10cSrcweir storeError 160cdf0e10cSrcweir FileLockBytes_createInstance ( 161cdf0e10cSrcweir rtl::Reference< store::ILockBytes > & rxLockBytes, 162cdf0e10cSrcweir rtl_uString * pFilename, 163cdf0e10cSrcweir storeAccessMode eAccessMode 164cdf0e10cSrcweir ); 165cdf0e10cSrcweir 166cdf0e10cSrcweir storeError 167cdf0e10cSrcweir MemoryLockBytes_createInstance ( 168cdf0e10cSrcweir rtl::Reference< store::ILockBytes > & rxLockBytes 169cdf0e10cSrcweir ); 170cdf0e10cSrcweir 171cdf0e10cSrcweir /*======================================================================== 172cdf0e10cSrcweir * 173cdf0e10cSrcweir * The End. 174cdf0e10cSrcweir * 175cdf0e10cSrcweir *======================================================================*/ 176cdf0e10cSrcweir 177cdf0e10cSrcweir } // namespace store 178cdf0e10cSrcweir 179cdf0e10cSrcweir #endif /* !_STORE_LOCKBYTE_HXX_ */ 180cdf0e10cSrcweir 181