LibreOffice Module store (master) 1
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
store::OStoreLockBytes Class Reference

#include <storlckb.hxx>

Inheritance diagram for store::OStoreLockBytes:
[legend]
Collaboration diagram for store::OStoreLockBytes:
[legend]

Public Member Functions

 OStoreLockBytes ()
 
storeError create (OStorePageManager *pManager, rtl_String const *pPath, rtl_String const *pName, storeAccessMode eAccessMode)
 create (two-phase construction). More...
 
storeError readAt (sal_uInt32 nOffset, void *pBuffer, sal_uInt32 nBytes, sal_uInt32 &rnDone)
 Read at Offset into Buffer. More...
 
storeError writeAt (sal_uInt32 nOffset, const void *pBuffer, sal_uInt32 nBytes, sal_uInt32 &rnDone)
 Write at Offset from Buffer. More...
 
storeError setSize (sal_uInt32 nSize)
 setSize. More...
 
virtual bool isKindOf (sal_uInt32 nMagic) override
 IStoreHandle. More...
 
- Public Member Functions inherited from store::OStoreObject
 OStoreObject ()
 
virtual bool isKindOf (sal_uInt32 nTypeId)
 Replaces dynamic_cast type checking. More...
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Protected Member Functions

virtual ~OStoreLockBytes () override
 
- Protected Member Functions inherited from store::OStoreObject
virtual ~OStoreObject () override
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 

Private Types

typedef OStoreDataPageData data
 
typedef OStoreDirectoryPageData inode
 
typedef PageHolderObject< inode > inode_holder_type
 

Private Member Functions

 OStoreLockBytes (const OStoreLockBytes &)=delete
 
OStoreLockBytes & operator= (const OStoreLockBytes &)=delete
 

Private Attributes

rtl::Reference< OStorePageManager > m_xManager
 
inode_holder_type m_xNode
 
bool m_bWriteable
 

Static Private Attributes

static const sal_uInt32 m_nTypeId
 IStoreHandle TypeId. More...
 

Friends

OStoreLockBytes *SAL_CALL query (OStoreObject *pHandle, OStoreLockBytes *)
 IStoreHandle query() template specialization. More...
 

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 37 of file storlckb.hxx.

Member Typedef Documentation

◆ data

typedef OStoreDataPageData store::OStoreLockBytes::data
private

Definition at line 106 of file storlckb.hxx.

◆ inode

typedef OStoreDirectoryPageData store::OStoreLockBytes::inode
private

Definition at line 107 of file storlckb.hxx.

◆ inode_holder_type

typedef PageHolderObject< inode > store::OStoreLockBytes::inode_holder_type
private

Definition at line 109 of file storlckb.hxx.

Constructor & Destructor Documentation

◆ OStoreLockBytes() [1/2]

OStoreLockBytes::OStoreLockBytes ( )

Definition at line 37 of file storlckb.cxx.

◆ ~OStoreLockBytes()

OStoreLockBytes::~OStoreLockBytes ( )
overrideprotectedvirtual

Definition at line 42 of file storlckb.cxx.

References store::PageHolderObject< T >::is(), store::PageData::m_aDescr, m_xManager, and m_xNode.

◆ OStoreLockBytes() [2/2]

store::OStoreLockBytes::OStoreLockBytes ( const OStoreLockBytes &  )
privatedelete

Member Function Documentation

◆ create()

storeError OStoreLockBytes::create ( OStorePageManager *  pManager,
rtl_String const *  pPath,
rtl_String const *  pName,
storeAccessMode  eAccessMode 
)

create (two-phase construction).

Parameters
pManager[in]
pPath[in]
pName[in]
eMode[in]
Returns
store_E_None upon success

Definition at line 55 of file storlckb.cxx.

References store::OStoreDirectoryPageObject::attrib(), Create, eMode, store::OStorePageObject::get(), store::PageData::m_aDescr, m_bWriteable, m_xManager, m_xNode, pName, ReadOnly, ReadWrite, setSize(), STORE_ATTRIB_ISFILE, STORE_ATTRIB_ISLINK, store_E_InvalidAccess, store_E_InvalidParameter, store_E_None, and store_E_NotFile.

◆ isKindOf()

bool OStoreLockBytes::isKindOf ( sal_uInt32  nMagic)
overridevirtual

IStoreHandle.

Reimplemented from store::OStoreObject.

Definition at line 50 of file storlckb.cxx.

References m_nTypeId.

◆ operator=()

OStoreLockBytes & store::OStoreLockBytes::operator= ( const OStoreLockBytes &  )
privatedelete

◆ readAt()

storeError OStoreLockBytes::readAt ( sal_uInt32  nOffset,
void *  pBuffer,
sal_uInt32  nBytes,
sal_uInt32 &  rnDone 
)

Read at Offset into Buffer.

Parameters
nOffset[in]
pBuffer[out]
nBytes[in]
rnDone[out]
Returns
store_E_None upon success

Definition at line 103 of file storlckb.cxx.

References aData, store::OStoreDataPageData::capacity(), store::OStoreDirectoryPageData::capacity(), store::OStoreDirectoryPageObject::dataLength(), store::PageHolderObject< T >::get(), store::PageData::m_aDescr, store::OStoreDirectoryPageData::ChunkDescriptor::m_nLength, store::OStoreDirectoryPageData::ChunkDescriptor::m_nOffset, store::OStoreDirectoryPageData::ChunkDescriptor::m_nPage, store::OStoreDirectoryPageData::m_pData, m_xManager, m_xNode, nLength, pData, store::OStoreDirectoryPageObject::read(), store::OStoreDirectoryPageData::scope(), store::OStoreDirectoryPageData::SCOPE_INTERNAL, store_E_InvalidAccess, store_E_InvalidParameter, store_E_None, and store_E_NotExists.

◆ setSize()

storeError OStoreLockBytes::setSize ( sal_uInt32  nSize)

setSize.

Parameters
nSize[in]
Returns
store_E_None upon success

Definition at line 323 of file storlckb.cxx.

References store::OStoreDataPageData::capacity(), store::OStoreDirectoryPageData::capacity(), store::OStoreDirectoryPageObject::dataLength(), store::PageHolderObject< T >::get(), store::OStorePageObject::location(), store::PageData::m_aDescr, m_bWriteable, store::OStoreDirectoryPageData::ChunkDescriptor::m_nLength, store::OStoreDirectoryPageData::ChunkDescriptor::m_nOffset, store::OStoreDirectoryPageData::ChunkDescriptor::m_nPage, store::OStoreDirectoryPageData::m_pData, m_xManager, m_xNode, store::OStoreDirectoryPageData::scope(), store::OStoreDirectoryPageData::SCOPE_EXTERNAL, store::OStoreDirectoryPageData::SCOPE_INTERNAL, store_E_AccessViolation, store_E_InvalidAccess, store_E_None, and store::OStoreDirectoryPageObject::truncate().

Referenced by create().

◆ writeAt()

storeError OStoreLockBytes::writeAt ( sal_uInt32  nOffset,
const void *  pBuffer,
sal_uInt32  nBytes,
sal_uInt32 &  rnDone 
)

Write at Offset from Buffer.

Parameters
nOffset[in]
pBuffer[in]
nBytes[in]
rnDone[out]
Returns
store_E_None upon success

Definition at line 200 of file storlckb.cxx.

References aData, store::OStoreDataPageData::capacity(), store::OStoreDirectoryPageData::capacity(), store::OStoreDirectoryPageObject::dataLength(), store::OStorePageObject::dirty(), store::PageHolderObject< T >::get(), store::PageHolderObject< T >::is(), store::OStorePageObject::location(), store::PageData::m_aDescr, m_bWriteable, store::OStoreDirectoryPageData::ChunkDescriptor::m_nLength, store::OStoreDirectoryPageData::ChunkDescriptor::m_nOffset, store::OStoreDirectoryPageData::ChunkDescriptor::m_nPage, store::OStoreDirectoryPageData::m_pData, m_xManager, m_xNode, nLength, pData, store::OStoreDirectoryPageObject::read(), store::OStoreDirectoryPageData::scope(), store::OStoreDirectoryPageData::SCOPE_INTERNAL, store_E_AccessViolation, store_E_InvalidAccess, store_E_InvalidParameter, store_E_None, store_E_NotExists, store::OStorePageObject::touch(), and store::OStoreDirectoryPageObject::write().

Friends And Related Function Documentation

◆ query

OStoreLockBytes *SAL_CALL query ( OStoreObject *  pHandle,
OStoreLockBytes *   
)
friend

IStoreHandle query() template specialization.

Member Data Documentation

◆ m_bWriteable

bool store::OStoreLockBytes::m_bWriteable
private

Definition at line 112 of file storlckb.hxx.

Referenced by create(), setSize(), and writeAt().

◆ m_nTypeId

const sal_uInt32 OStoreLockBytes::m_nTypeId
staticprivate

IStoreHandle TypeId.

Definition at line 97 of file storlckb.hxx.

Referenced by isKindOf(), and store::query().

◆ m_xManager

rtl::Reference<OStorePageManager> store::OStoreLockBytes::m_xManager
private

Definition at line 104 of file storlckb.hxx.

Referenced by create(), readAt(), setSize(), writeAt(), and ~OStoreLockBytes().

◆ m_xNode

inode_holder_type store::OStoreLockBytes::m_xNode
private

Definition at line 110 of file storlckb.hxx.

Referenced by create(), readAt(), setSize(), writeAt(), and ~OStoreLockBytes().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:26:34 for LibreOffice Module store (master) by doxygen 1.9.3