store::ILockBytes Class Reference

#include <lockbyte.hxx>

Inheritance diagram for store::ILockBytes:

Collaboration diagram for store::ILockBytes:

Public Member Functions
storeError	initialize (rtl::Reference< PageData::Allocator > &rxAllocator, sal_uInt16 nPageSize)
storeError	readPageAt (std::shared_ptr< PageData > &rPage, sal_uInt32 nOffset)
storeError	writePageAt (std::shared_ptr< PageData > const &rPage, sal_uInt32 nOffset)
storeError	readAt (sal_uInt32 nOffset, void *pBuffer, sal_uInt32 nBytes)
storeError	writeAt (sal_uInt32 nOffset, const void *pBuffer, sal_uInt32 nBytes)
storeError	getSize (sal_uInt32 &rnSize)
storeError	setSize (sal_uInt32 nSize)
storeError	flush ()
Public Member Functions inherited from salhelper::SimpleReferenceObject
	SimpleReferenceObject ()
void	acquire ()
void	release ()

Protected Member Functions
virtual	~ILockBytes () override
Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual	~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE

Private Member Functions
virtual storeError	initialize_Impl (rtl::Reference< PageData::Allocator > &rxAllocator, sal_uInt16 nPageSize)=0
	Implementation (abstract). More...
virtual storeError	readPageAt_Impl (std::shared_ptr< PageData > &rPage, sal_uInt32 nOffset)=0
virtual storeError	writePageAt_Impl (std::shared_ptr< PageData > 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

Additional Inherited Members
Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void *	operator new (std::size_t nSize)
static void *	operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
static void	operator delete (void *pPtr)
static void	operator delete (void *pPtr, std::nothrow_t const &rNothrow)
Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount	m_nCount

Detailed Description

Definition at line 39 of file lockbyte.hxx.

Constructor & Destructor Documentation

~ILockBytes()

virtual store::ILockBytes::~ILockBytes ( )

inlineoverrideprotectedvirtual

Definition at line 106 of file lockbyte.hxx.

Member Function Documentation

flush()

storeError ILockBytes::flush

(

)

Returns

store_E_None upon success

Definition at line 127 of file lockbyte.cxx.

References flush_Impl().

flush_Impl()

virtual storeError store::ILockBytes::flush_Impl ( )

privatepure virtual

Referenced by flush().

getSize()

storeError ILockBytes::getSize

(

sal_uInt32 &

rnSize

)

Parameters

rnSize

[out]

Returns

store_E_None upon success

Definition at line 116 of file lockbyte.cxx.

References getSize_Impl().

getSize_Impl()

virtual storeError store::ILockBytes::getSize_Impl ( sal_uInt32 &  rnSize )

privatepure virtual

Referenced by getSize().

initialize()

storeError ILockBytes::initialize	(	rtl::Reference< PageData::Allocator > &	rxAllocator,
		sal_uInt16	nPageSize
	)

Parameters

rxAllocator	[out]
nPageSize	[in]

Definition at line 37 of file lockbyte.cxx.

References initialize_Impl(), STORE_MAXIMUM_PAGESIZE, and STORE_MINIMUM_PAGESIZE.

initialize_Impl()

virtual storeError store::ILockBytes::initialize_Impl ( rtl::Reference< PageData::Allocator > &  rxAllocator, sal_uInt16  nPageSize  )

privatepure virtual

Implementation (abstract).

Referenced by initialize().

readAt()

storeError ILockBytes::readAt	(	sal_uInt32	nOffset,
		void *	pBuffer,
		sal_uInt32	nBytes
	)

Parameters

nOffset	[in]
pBuffer	[out]
nBytes	[in]

Returns

store_E_None upon success

Definition at line 72 of file lockbyte.cxx.

References readAt_Impl(), SAL_MAX_UINT32, store_E_CantSeek, store_E_InvalidParameter, store_E_None, and STORE_PAGE_NULL.

readAt_Impl()

virtual storeError store::ILockBytes::readAt_Impl ( sal_uInt32  nOffset, void *  pBuffer, sal_uInt32  nBytes  )

privatepure virtual

Referenced by readAt().

readPageAt()

storeError ILockBytes::readPageAt	(	std::shared_ptr< PageData > &	rPage,
		sal_uInt32	nOffset
	)

Parameters

rPage	[out]
nOffset	[in]

Definition at line 43 of file lockbyte.cxx.

References readPageAt_Impl(), store_E_CantSeek, and STORE_PAGE_NULL.

readPageAt_Impl()

virtual storeError store::ILockBytes::readPageAt_Impl ( std::shared_ptr< PageData > &  rPage, sal_uInt32  nOffset  )

privatepure virtual

Referenced by readPageAt().

setSize()

storeError ILockBytes::setSize

(

sal_uInt32

nSize

)

Parameters

nSize

[in]

Returns

store_E_None upon success

Definition at line 122 of file lockbyte.cxx.

References setSize_Impl().

setSize_Impl()

virtual storeError store::ILockBytes::setSize_Impl ( sal_uInt32  nSize )

privatepure virtual

Referenced by setSize().

writeAt()

storeError ILockBytes::writeAt	(	sal_uInt32	nOffset,
		const void *	pBuffer,
		sal_uInt32	nBytes
	)

Parameters

nOffset	[in]
pBuffer	[in]
nBytes	[in]

Returns

store_E_None upon success

Definition at line 94 of file lockbyte.cxx.

References SAL_MAX_UINT32, store_E_CantSeek, store_E_InvalidParameter, store_E_None, STORE_PAGE_NULL, and writeAt_Impl().

writeAt_Impl()

virtual storeError store::ILockBytes::writeAt_Impl ( sal_uInt32  nOffset, const void *  pBuffer, sal_uInt32  nBytes  )

privatepure virtual

Referenced by writeAt().

writePageAt()

storeError ILockBytes::writePageAt	(	std::shared_ptr< PageData > const &	rPage,
		sal_uInt32	nOffset
	)

Parameters

rPage	[in]
nOffset	[in]

Definition at line 52 of file lockbyte.cxx.

References store::PageData::location(), store_E_CantSeek, store_E_InvalidParameter, STORE_PAGE_NULL, and writePageAt_Impl().

writePageAt_Impl()

virtual storeError store::ILockBytes::writePageAt_Impl ( std::shared_ptr< PageData > const &  rPage, sal_uInt32  nOffset  )

privatepure virtual

Referenced by writePageAt().

---

The documentation for this class was generated from the following files:

• lockbyte.hxx
• lockbyte.cxx