Free Electron
Public Member Functions | Friends | List of all members
fe::StoreI Class Referenceabstract

Base class for state block memeory managers. More...

#include <StoreI.h>

Inheritance diagram for fe::StoreI:
Inheritance graph
[legend]

Public Member Functions

virtual void * createSB (void)=0
 Create a state block. More...
 
virtual void * createSB (FE_UWORD count)=0
 Create an array of state blocks. More...
 
virtual hp< LayoutSB > & getLayout (void)=0
 Get the layout for this StoreI. More...
 
virtual void setLayout (sp< LayoutSB > &rspLayout)=0
 Set the layout for this StoreI. More...
 
virtual FE_UWORD skipSizeSB (void)=0
 Get the size of a state block created by this StoreI. More...
 
virtual void acquireSB (void *stateBlock)=0
 Acquire a state block. More...
 
virtual void releaseSB (const RecordSB &r_old)=0
 Release a state block. More...
 
virtual void freeSB (void *stateBlock)=0
 Free the state block. More...
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Friends

class LayoutSB
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

Base class for state block memeory managers.

Reference counting is maintained on state blocks that have the attribute C.

Member Function Documentation

◆ acquireSB()

virtual void fe::StoreI::acquireSB ( void *  stateBlock)
pure virtual

Acquire a state block.

Implemented in fe::SegmentStore.

◆ createSB() [1/2]

virtual void* fe::StoreI::createSB ( void  )
pure virtual

Create a state block.

Implemented in fe::SegmentStore.

◆ createSB() [2/2]

virtual void* fe::StoreI::createSB ( FE_UWORD  count)
pure virtual

Create an array of state blocks.

Implemented in fe::SegmentStore.

◆ freeSB()

virtual void fe::StoreI::freeSB ( void *  stateBlock)
pure virtual

Free the state block.

Use only on non-reference counted data blocks.

Implemented in fe::SegmentStore.

◆ getLayout()

virtual hp<LayoutSB>& fe::StoreI::getLayout ( void  )
pure virtual

Get the layout for this StoreI.

Implemented in fe::SegmentStore.

◆ releaseSB()

virtual void fe::StoreI::releaseSB ( const RecordSB r_old)
pure virtual

Release a state block.

Implemented in fe::SegmentStore.

◆ setLayout()

virtual void fe::StoreI::setLayout ( sp< LayoutSB > &  rspLayout)
pure virtual

Set the layout for this StoreI.

Implemented in fe::SegmentStore.

◆ skipSizeSB()

virtual FE_UWORD fe::StoreI::skipSizeSB ( void  )
pure virtual

Get the size of a state block created by this StoreI.

Implemented in fe::SegmentStore.


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