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
uint	announce (uint count)
	convenience shortcut to start a buffer handling cycle
size_t	determineBufferSize () const
BuffHandle	lockBuffer ()
	operator HashVal () const
bool	verifyValidity () const

Friends
class	BufferProvider
class	BuffHandle

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

Protected Attributes
BufferProvider *	provider_
HashVal	subClassification_

Collaboration diagram for BuffDescr:

---

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

• buffhandle.hpp
• buffer-provider.cpp