Lumiera  0.pre.03
»edit your freedom«
Entry Class Reference

#include "steam/engine/buffer-metadata.hpp"

Description

A complete metadata Entry, based on a Key.

This special Key element usually describes an actual Buffer. Entries are to be managed in a hashtable, which is "the metadata table". As a special case, an entry without a concrete buffer storage pointer can be created. This corresponds to a (plain) key and describes just a buffer type. Such type-only entries are fixed to the NIL state. All other entries allow for state transitions.

The "metadata table" with its entries is maintained by an engine::BufferMetadata instance. For the latter, Entry serves as representation and access point to the individual metadata; this includes using the TypeHandler for building and destroying buffer structures.

Definition at line 272 of file buffer-metadata.hpp.

Public Member Functions

void * access ()
 
Entryinvalidate (bool invokeDtor=true)
 
bool isLocked () const
 is this Entry currently associated to a concrete buffer? Is this buffer in use?
 
bool isTypeKey () const
 is this Entry just an (abstract) placeholder for a type? More...
 
Entrylock (void *newBuffer)
 
Entrymark (BufferState newState)
 Buffer state machine.
 
BufferState state () const
 

Friends

class engine::BufferMetadata
 BufferMetadata is allowed to create.
 

Protected Member Functions

 Entry (Key const &parent, void *bufferPtr=0, LocalKey const &implID=UNSPECIFIC)
 
void invokeEmbeddedCtor ()
 
void invokeEmbeddedDtor_and_clear ()
 

Private Member Functions

void __buffer_required () const
 
void __must_be_FREE () const
 
void __must_not_be_FREE () const
 
void __must_not_be_NIL () const
 

Private Attributes

void * buffer_
 
BufferState state_
 

Additional Inherited Members

Member Function Documentation

◆ isTypeKey()

bool isTypeKey ( ) const
inline

is this Entry just an (abstract) placeholder for a type?

Returns
false if it's a real entry corresponding to a concrete buffer

Definition at line 304 of file buffer-metadata.hpp.

Referenced by BufferProvider::attachTypeHandler().

+ Here is the caller graph for this function:

◆ invokeEmbeddedCtor()

void invokeEmbeddedCtor ( )
inlineprotected

maybe invoke a registered TypeHandler's constructor function, which typically builds some content object into the buffer by placement new.

Definition at line 376 of file buffer-metadata.hpp.

◆ invokeEmbeddedDtor_and_clear()

void invokeEmbeddedDtor_and_clear ( )
inlineprotected

maybe invoke a registered TypeHandler's destructor function, which typically clears up some content object living within the buffer

Definition at line 387 of file buffer-metadata.hpp.

+ Inheritance diagram for Entry:
+ Collaboration diagram for Entry:

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