| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _STORE_LOCKBYTE_HXX_ |
| #define _STORE_LOCKBYTE_HXX_ |
| |
| #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(); |
| |
| 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_ */ |
| |