BuffDescr Class Reference

#include "steam/engine/buffhandle.hpp"

Description

An opaque descriptor to identify the type and further properties of a data buffer.

For each kind of buffer, there is somewhere a BufferProvider responsible for the actual storage management. This provider may "lock" a buffer for actual use, returning a BuffHandle.

Note

this descriptor and especially the subClassification_ is really owned by the BufferProvider, which may use (and even change) the opaque contents to organise the internal buffer management.

Definition at line 77 of file buffhandle.hpp.

Public Member Functions
bool	verifyValidity () const
size_t	determineBufferSize () const
	operator HashVal () const
uint	announce (uint count)
	convenience shortcut to start a buffer handling cycle
BuffHandle	lockBuffer ()

Friends
class	BufferProvider
class	BuffHandle

Protected Member Functions
	BuffDescr (BufferProvider &manager, HashVal detail)

Protected Attributes
BufferProvider *	provider_
HashVal	subClassification_

Constructor & Destructor Documentation

BuffDescr()

BuffDescr ( BufferProvider &  manager, HashVal  detail  )

inlineprotected

Definition at line 83 of file buffhandle.hpp.

Member Function Documentation

verifyValidity()

bool verifyValidity

(

)

const

Definition at line 248 of file buffer-provider.cpp.

References BuffDescr::provider_, and BufferProvider::verifyValidity().

Referenced by BuffHandle::isValid(), and BufferProviderProtocol_test::verifyStandardCase().

Here is the call graph for this function:

Here is the caller graph for this function:

determineBufferSize()

size_t determineBufferSize

(

)

const

Definition at line 256 of file buffer-provider.cpp.

References BufferProvider::getBufferSize(), and BuffDescr::provider_.

Referenced by BuffHandle::size(), and BuffHandle::takeOwnershipFor().

Here is the call graph for this function:

Here is the caller graph for this function:

operator HashVal()

operator HashVal ( ) const

inline

Definition at line 97 of file buffhandle.hpp.

References BuffDescr::subClassification_.

announce()

uint announce

(

uint

count

)

convenience shortcut to start a buffer handling cycle

Definition at line 264 of file buffer-provider.cpp.

References BufferProvider::announce(), and BuffDescr::provider_.

Here is the call graph for this function:

lockBuffer()

BuffHandle lockBuffer

(

)

Definition at line 272 of file buffer-provider.cpp.

References BufferProvider::lockBuffer(), and BuffDescr::provider_.

Here is the call graph for this function:

Member Data Documentation

provider_

BufferProvider* provider_

protected

Definition at line 80 of file buffhandle.hpp.

Referenced by BuffDescr::announce(), BuffDescr::determineBufferSize(), BuffHandle::emergencyCleanup(), BuffHandle::emit(), BuffDescr::lockBuffer(), BuffHandle::release(), BuffHandle::takeOwnershipFor(), BuffHandle::takeOwnershipFor(), and BuffDescr::verifyValidity().

subClassification_

HashVal subClassification_

protected

Definition at line 81 of file buffhandle.hpp.

Referenced by BuffDescr::operator HashVal().

Friends And Related Symbol Documentation

BufferProvider

friend class BufferProvider

friend

Definition at line 88 of file buffhandle.hpp.

BuffHandle

friend class BuffHandle

friend

Definition at line 89 of file buffhandle.hpp.

Collaboration diagram for BuffDescr:

---

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

• buffhandle.hpp
• buffer-provider.cpp